Class: Vk::API::Account::Methods::SaveProfileInfo

Inherits:
Schema::Method
  • Object
show all
Defined in:
lib/vk/api/account/methods/save_profile_info.rb

Overview

Edits current profile info.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Account::Methods::SaveProfileInfo

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :first_name (String)

    User first name.

  • :last_name (String)

    User last name.

  • :maiden_name (String)

    User maiden name (female only)

  • :screen_name (String)

    User screen name.

  • :cancel_request_id (Integer)

    ID of the name change request to be canceled. If this paremeter is sent, all the others are ignored.

  • :sex (Integer)

    User sex. Possible values: ; * '1' – female;; * '2' – male.

  • :relation (Integer)

    User relationship status. Possible values: ; * '1' – single;; * '2' – in a relationship;; * '3' – engaged;; * '4' – married;; * '5' – it's complicated;; * '6' – actively searching;; * '7' – in love;; * '0' – not specified.

  • :relation_partner_id (Integer)

    ID of the relationship partner.

  • :bdate (String)

    User birth date, format: DD.MM.YYYY.

  • :bdate_visibility (Integer)

    Birth date visibility. Returned values: ; * '1' – show birth date;; * '2' – show only month and date;; * '0' – hide birth date.

  • :home_town (String)

    User home town.

  • :country_id (Integer)

    User country.

  • :city_id (Integer)

    User city.

  • :status (String)

    Status text.


# File 'lib/vk/api/account/methods/save_profile_info.rb', line 15

Instance Method Details

#bdateString

Returns User birth date, format: DD.MM.YYYY.

Returns:

  • (String)

    User birth date, format: DD.MM.YYYY.


52
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 52

attribute :bdate, API::Types::Coercible::String.optional.default(nil)

#bdate_visibilityInteger

Returns Birth date visibility. Returned values: ; * '1' – show birth date;; * '2' – show only month and date;; * '0' – hide birth date.

Returns:

  • (Integer)

    Birth date visibility. Returned values: ; * '1' – show birth date;; * '2' – show only month and date;; * '0' – hide birth date.


54
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 54

attribute :bdate_visibility, API::Types::Coercible::Int.optional.default(nil)

#cancel_request_idInteger

Returns ID of the name change request to be canceled. If this paremeter is sent, all the others are ignored.

Returns:

  • (Integer)

    ID of the name change request to be canceled. If this paremeter is sent, all the others are ignored.


44
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 44

attribute :cancel_request_id, API::Types::Coercible::Int.optional.default(nil)

#city_idInteger

Returns User city.

Returns:

  • (Integer)

    User city.


60
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 60

attribute :city_id, API::Types::Coercible::Int.optional.default(nil)

#country_idInteger

Returns User country.

Returns:

  • (Integer)

    User country.


58
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 58

attribute :country_id, API::Types::Coercible::Int.optional.default(nil)

#first_nameString

Returns User first name.

Returns:

  • (String)

    User first name.


36
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 36

attribute :first_name, API::Types::Coercible::String.optional.default(nil)

#home_townString

Returns User home town.

Returns:

  • (String)

    User home town.


56
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 56

attribute :home_town, API::Types::Coercible::String.optional.default(nil)

#last_nameString

Returns User last name.

Returns:

  • (String)

    User last name.


38
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 38

attribute :last_name, API::Types::Coercible::String.optional.default(nil)

#maiden_nameString

Returns User maiden name (female only).

Returns:

  • (String)

    User maiden name (female only)


40
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 40

attribute :maiden_name, API::Types::Coercible::String.optional.default(nil)

#relationInteger

Returns User relationship status. Possible values: ; * '1' – single;; * '2' – in a relationship;; * '3' – engaged;; * '4' – married;; * '5' – it's complicated;; * '6' – actively searching;; * '7' – in love;; * '0' – not specified.

Returns:

  • (Integer)

    User relationship status. Possible values: ; * '1' – single;; * '2' – in a relationship;; * '3' – engaged;; * '4' – married;; * '5' – it's complicated;; * '6' – actively searching;; * '7' – in love;; * '0' – not specified.


48
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 48

attribute :relation, API::Types::Coercible::Int.optional.default(nil)

#relation_partner_idInteger

Returns ID of the relationship partner.

Returns:

  • (Integer)

    ID of the relationship partner.


50
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 50

attribute :relation_partner_id, API::Types::Coercible::Int.optional.default(nil)

#screen_nameString

Returns User screen name.

Returns:

  • (String)

    User screen name.


42
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 42

attribute :screen_name, API::Types::Coercible::String.optional.default(nil)

#sexInteger

Returns User sex. Possible values: ; * '1' – female;; * '2' – male.

Returns:

  • (Integer)

    User sex. Possible values: ; * '1' – female;; * '2' – male.


46
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 46

attribute :sex, API::Types::Coercible::Int.optional.default(nil)

#statusString

Returns Status text.

Returns:

  • (String)

    Status text.


62
# File 'lib/vk/api/account/methods/save_profile_info.rb', line 62

attribute :status, API::Types::Coercible::String.optional.default(nil)