Class: Vk::API::Account::UserSettings

Inherits:

Schema::Object

• Object
• Dry::Struct
• Schema::Object
• Vk::API::Account::UserSettings

Defined in:

lib/vk/api/account/user_settings.rb

Overview

See Also:

• https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

Instance Method Summary

• #bdate ⇒ String

  User's date of birth.

• #bdate_visibility ⇒ Integer

  Information whether user's birthdate are hidden.

• #city ⇒ API::Base::Object
• #country ⇒ API::Base::Country
• #first_name ⇒ String

  User first name.

• #home_town ⇒ String

  User's hometown.

• #last_name ⇒ String

  User last name.

• #maiden_name ⇒ String

  User maiden name.

• #name_request ⇒ API::Account::NameRequest
• #phone ⇒ String

  User phone number with some hidden digits.

• #relation ⇒ Integer

  User relationship status.

• #relation_partner ⇒ API::Users::UserMin
• #relation_pending ⇒ Integer

  Information whether relation status is pending.

• #relation_requests ⇒ Array
• #screen_name ⇒ String

  Domain name of the user's page.

• #sex ⇒ Integer

  User sex.

• #status ⇒ String

  User status.

Instance Method Details

#bdate ⇒ String

Returns User's date of birth.

Returns:

• (String) —

  User's date of birth

# File 'lib/vk/api/account/user_settings.rb', line 29

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

#bdate_visibility ⇒ Integer

Returns Information whether user's birthdate are hidden.

Returns:

• (Integer) —

  Information whether user's birthdate are hidden

# File 'lib/vk/api/account/user_settings.rb', line 31

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

#city ⇒ API::Base::Object

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Base::Object) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/account/user_settings.rb', line 37

attribute :city, Dry::Types[API::Base::Object].optional.default(nil)

#country ⇒ API::Base::Country

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Base::Country) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/account/user_settings.rb', line 35

attribute :country, Dry::Types[API::Base::Country].optional.default(nil)

#first_name ⇒ String

Returns User first name.

Returns:

• (String) —

  User first name

# File 'lib/vk/api/account/user_settings.rb', line 11

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

#home_town ⇒ String

Returns User's hometown.

Returns:

• (String) —

  User's hometown

# File 'lib/vk/api/account/user_settings.rb', line 33

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

#last_name ⇒ String

Returns User last name.

Returns:

• (String) —

  User last name

# File 'lib/vk/api/account/user_settings.rb', line 13

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

#maiden_name ⇒ String

Returns User maiden name.

Returns:

• (String) —

  User maiden name

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

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

#name_request ⇒ API::Account::NameRequest

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Account::NameRequest) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/account/user_settings.rb', line 43

attribute :name_request, Dry::Types[API::Account::NameRequest].optional.default(nil)

#phone ⇒ String

Returns User phone number with some hidden digits.

Returns:

• (String) —

  User phone number with some hidden digits

# File 'lib/vk/api/account/user_settings.rb', line 41

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

#relation ⇒ Integer

Returns User relationship status.

Returns:

• (Integer) —

  User relationship status

# File 'lib/vk/api/account/user_settings.rb', line 21

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

#relation_partner ⇒ API::Users::UserMin

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (API::Users::UserMin) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/account/user_settings.rb', line 23

attribute :relation_partner, Dry::Types[API::Users::UserMin].optional.default(nil)

#relation_pending ⇒ Integer

Returns Information whether relation status is pending.

Returns:

• (Integer) —

  Information whether relation status is pending

# File 'lib/vk/api/account/user_settings.rb', line 25

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

#relation_requests ⇒ Array

Returns @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json.

Returns:

• (Array) —

  @see https://github.com/VKCOM/vk-api-schema/blob/master/objects.json

# File 'lib/vk/api/account/user_settings.rb', line 27

attribute :relation_requests, API::Types::Coercible::Array.member(API::Users::UserMin).optional.default(nil)

#screen_name ⇒ String

Returns Domain name of the user's page.

Returns:

• (String) —

  Domain name of the user's page

# File 'lib/vk/api/account/user_settings.rb', line 17

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

#sex ⇒ Integer

Returns User sex.

Returns:

• (Integer) —

  User sex

# File 'lib/vk/api/account/user_settings.rb', line 19

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

#status ⇒ String

Returns User status.

Returns:

• (String) —

  User status

# File 'lib/vk/api/account/user_settings.rb', line 39

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