Class: Vk::API::Account

Inherits:
Schema::Namespace show all
Defined in:
lib/vk/api/types.rb,
lib/vk/api/methods.rb,
lib/vk/api/objects.rb,
lib/vk/api/responses.rb,
lib/vk/api/account/info.rb,
lib/vk/api/account/offer.rb,
lib/vk/api/account/push_params.rb,
lib/vk/api/account/name_request.rb,
lib/vk/api/account/lookup_result.rb,
lib/vk/api/account/onoff_options.rb,
lib/vk/api/account/push_settings.rb,
lib/vk/api/account/user_settings.rb,
lib/vk/api/account/account_counters.rb,
lib/vk/api/account/methods/ban_user.rb,
lib/vk/api/account/methods/get_info.rb,
lib/vk/api/account/methods/set_info.rb,
lib/vk/api/account/user_xtr_contacts.rb,
lib/vk/api/account/methods/get_banned.rb,
lib/vk/api/account/methods/set_online.rb,
lib/vk/api/account/methods/unban_user.rb,
lib/vk/api/account/methods/set_offline.rb,
lib/vk/api/account/methods/get_counters.rb,
lib/vk/api/account/methods/change_password.rb,
lib/vk/api/account/methods/lookup_contacts.rb,
lib/vk/api/account/methods/register_device.rb,
lib/vk/api/account/methods/get_profile_info.rb,
lib/vk/api/account/methods/set_name_in_menu.rb,
lib/vk/api/account/methods/set_silence_mode.rb,
lib/vk/api/account/methods/get_active_offers.rb,
lib/vk/api/account/methods/get_push_settings.rb,
lib/vk/api/account/methods/save_profile_info.rb,
lib/vk/api/account/methods/set_push_settings.rb,
lib/vk/api/account/methods/unregister_device.rb,
lib/vk/api/account/methods/get_app_permissions.rb,
lib/vk/api/account/responses/ban_user_response.rb,
lib/vk/api/account/responses/get_info_response.rb,
lib/vk/api/account/responses/set_info_response.rb,
lib/vk/api/account/responses/get_banned_response.rb,
lib/vk/api/account/responses/set_online_response.rb,
lib/vk/api/account/responses/unban_user_response.rb,
lib/vk/api/account/responses/set_offline_response.rb,
lib/vk/api/account/responses/get_counters_response.rb,
lib/vk/api/account/responses/change_password_response.rb,
lib/vk/api/account/responses/lookup_contacts_response.rb,
lib/vk/api/account/responses/register_device_response.rb,
lib/vk/api/account/responses/get_profile_info_response.rb,
lib/vk/api/account/responses/set_name_in_menu_response.rb,
lib/vk/api/account/responses/set_silence_mode_response.rb,
lib/vk/api/account/responses/get_active_offers_response.rb,
lib/vk/api/account/responses/get_push_settings_response.rb,
lib/vk/api/account/responses/save_profile_info_response.rb,
lib/vk/api/account/responses/set_push_settings_response.rb,
lib/vk/api/account/responses/unregister_device_response.rb,
lib/vk/api/account/responses/get_app_permissions_response.rb

Defined Under Namespace

Modules: Methods, Responses Classes: AccountCounters, Info, LookupResult, NameRequest, Offer, PushParams, PushSettings, UserSettings, UserXtrContacts

Constant Summary collapse

OnoffOptions =

Settings parameters

API::Types::Coercible::String.enum('on', 'off')

Instance Attribute Summary

Attributes inherited from Schema::Namespace

#client

DSL collapse

Methods inherited from Schema::Namespace

#call, #initialize

Constructor Details

This class inherits a constructor from Vk::Schema::Namespace

Instance Method Details

#ban_user(arguments = {}) ⇒ Vk::API::Account::Responses::BanUserResponse

Returns Adds user to the banlist.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer) —

    User ID.

Returns:

See Also:



3968
3969
3970
3971
3972
3973
3974
 
# File 'lib/vk/api/methods.rb', line 3968

def ban_user(arguments = {})
  require "vk/api/account/methods/ban_user"
  method = Methods::BanUser.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/ban_user_response"
  Responses::BanUserResponse.new(response.deep_symbolize_keys)
end

#change_password(arguments = {}) ⇒ Vk::API::Account::Responses::ChangePasswordResponse

Returns Changes a user password after access is successfully restored with the method.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :restore_sid (String) —

    Session id received after the method is executed.; (If the password is changed right after the access was restored)

  • :change_password_hash (String) —

    Hash received after a successful OAuth authorization with a code got by SMS.; (If the password is changed right after the access was restored)

  • :old_password (String) —

    Current user password.

  • :new_password (String) —

    New password that will be set as a current

Returns:

See Also:



4028
4029
4030
4031
4032
4033
4034
 
# File 'lib/vk/api/methods.rb', line 4028

def change_password(arguments = {})
  require "vk/api/account/methods/change_password"
  method = Methods::ChangePassword.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/change_password_response"
  Responses::ChangePasswordResponse.new(response.deep_symbolize_keys)
end

#get_active_offers(arguments = {}) ⇒ Vk::API::Account::Responses::GetActiveOffersResponse

Returns a list of active ads (offers) which executed by the user will bring him/her respective number of votes to his balance in the application.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :count (Integer) — default: 100 —

    Number of results to return.

Returns:

See Also:



3957
3958
3959
3960
3961
3962
3963
 
# File 'lib/vk/api/methods.rb', line 3957

def get_active_offers(arguments = {})
  require "vk/api/account/methods/get_active_offers"
  method = Methods::GetActiveOffers.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_active_offers_response"
  Responses::GetActiveOffersResponse.new(response.deep_symbolize_keys)
end

#get_app_permissions(arguments = {}) ⇒ Vk::API::Account::Responses::GetAppPermissionsResponse

Returns Gets settings of the user in this application.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer) —

    User ID whose settings information shall be got. By default: current user.

Returns:

See Also:



3946
3947
3948
3949
3950
3951
3952
 
# File 'lib/vk/api/methods.rb', line 3946

def get_app_permissions(arguments = {})
  require "vk/api/account/methods/get_app_permissions"
  method = Methods::GetAppPermissions.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_app_permissions_response"
  Responses::GetAppPermissionsResponse.new(response.deep_symbolize_keys)
end

#get_banned(arguments = {}) ⇒ Vk::API::Account::Responses::GetBannedResponse

Returns a user's blacklist.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :offset (Integer) —

    Offset needed to return a specific subset of results.

  • :count (Integer) — default: 20 —

    Number of results to return.

Returns:

See Also:



3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/vk/api/methods.rb', line 3991

def get_banned(arguments = {})
  require "vk/api/account/methods/get_banned"
  method = Methods::GetBanned.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_banned_response"
  Responses::GetBannedResponse.new(response.deep_symbolize_keys)
end

#get_counters(arguments = {}) ⇒ Vk::API::Account::Responses::GetCountersResponse

Returns non-null values of user counters.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :filter (Array) —

    Counters to be returned (friends, messages, photos, videos, notes, gifts, events, groups, sdk).

Returns:

See Also:



3821
3822
3823
3824
3825
3826
3827
 
# File 'lib/vk/api/methods.rb', line 3821

def get_counters(arguments = {})
  require "vk/api/account/methods/get_counters"
  method = Methods::GetCounters.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_counters_response"
  Responses::GetCountersResponse.new(response.deep_symbolize_keys)
end

#get_info(arguments = {}) ⇒ Vk::API::Account::Responses::GetInfoResponse

Returns current account info.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :fields (Array) —

    Fields to return. Possible values:; *'country' — user country;; *'https_required' — is "HTTPS only" option enabled;; *'own_posts_default' — is "Show my posts only" option is enabled;; *'no_wall_replies' — are wall replies disabled or not;; *'intro' — is intro passed by user or not;; *'lang' — user language.; ; By default: all.

Returns:

See Also:



4002
4003
4004
4005
4006
4007
4008
 
# File 'lib/vk/api/methods.rb', line 4002

def get_info(arguments = {})
  require "vk/api/account/methods/get_info"
  method = Methods::GetInfo.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_info_response"
  Responses::GetInfoResponse.new(response.deep_symbolize_keys)
end

#get_profile_info(arguments = {}) ⇒ Vk::API::Account::Responses::GetProfileInfoResponse

Returns the current account info.

Parameters:

  • arguments (Hash) (defaults to: {})

Returns:

See Also:



4038
4039
4040
4041
4042
4043
4044
 
# File 'lib/vk/api/methods.rb', line 4038

def get_profile_info(arguments = {})
  require "vk/api/account/methods/get_profile_info"
  method = Methods::GetProfileInfo.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_profile_info_response"
  Responses::GetProfileInfoResponse.new(response.deep_symbolize_keys)
end

#get_push_settings(arguments = {}) ⇒ Vk::API::Account::Responses::GetPushSettingsResponse

Returns Gets settings of push notifications.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :device_id (String) —

    Unique device ID.

Returns:

See Also:



3921
3922
3923
3924
3925
3926
3927
 
# File 'lib/vk/api/methods.rb', line 3921

def get_push_settings(arguments = {})
  require "vk/api/account/methods/get_push_settings"
  method = Methods::GetPushSettings.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/get_push_settings_response"
  Responses::GetPushSettingsResponse.new(response.deep_symbolize_keys)
end

#lookup_contacts(arguments = {}) ⇒ Vk::API::Account::Responses::LookupContactsResponse

Returns Allows to search the VK users using phone numbers, e-mail addresses and user IDs on other services.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :contacts (Array) —

    List of contacts separated with commas

  • :service (String) —

    String identifier of a service which contacts are used for searching. Possible values: ; * email; * phone; * twitter; * facebook; * odnoklassniki; * instagram; * google

  • :mycontact (String) —

    Contact of a current user on a specified service

  • :return_all (Boolean) —

    '1' – also return contacts found using this service before, '0' – return only contacts found using 'contacts' field.

  • :fields (Array) —

    Profile fields to return. Possible values: 'nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities'.

Returns:

See Also:



3869
3870
3871
3872
3873
3874
3875
 
# File 'lib/vk/api/methods.rb', line 3869

def lookup_contacts(arguments = {})
  require "vk/api/account/methods/lookup_contacts"
  method = Methods::LookupContacts.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/lookup_contacts_response"
  Responses::LookupContactsResponse.new(response.deep_symbolize_keys)
end

#register_device(arguments = {}) ⇒ Vk::API::Account::Responses::RegisterDeviceResponse

Returns Subscribes an iOS/Android/Windows Phone-based device to receive push notifications.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :token (String) —

    Device token used to send notifications. (for mpns, the token shall be URL for sending of notifications)

  • :device_model (String) —

    String name of device model.

  • :device_year (Integer) —

    Device year.

  • :device_id (String) —

    Unique device ID.

  • :system_version (String) —

    String version of device operating system.

  • :settings (String) —

    Push settings in a .

Returns:

See Also:



3885
3886
3887
3888
3889
3890
3891
 
# File 'lib/vk/api/methods.rb', line 3885

def register_device(arguments = {})
  require "vk/api/account/methods/register_device"
  method = Methods::RegisterDevice.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/register_device_response"
  Responses::RegisterDeviceResponse.new(response.deep_symbolize_keys)
end

#save_profile_info(arguments = {}) ⇒ Vk::API::Account::Responses::SaveProfileInfoResponse

Returns Edits current profile info.

Parameters:

  • arguments (Hash) (defaults to: {})

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.

Returns:

See Also:



4062
4063
4064
4065
4066
4067
4068
 
# File 'lib/vk/api/methods.rb', line 4062

def save_profile_info(arguments = {})
  require "vk/api/account/methods/save_profile_info"
  method = Methods::SaveProfileInfo.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/save_profile_info_response"
  Responses::SaveProfileInfoResponse.new(response.deep_symbolize_keys)
end

#set_info(arguments = {}) ⇒ Vk::API::Account::Responses::SetInfoResponse

Returns Allows to edit the current account info.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :name (String) —

    Setting name.

  • :value (String) —

    Setting value.

Returns:

See Also:



4014
4015
4016
4017
4018
4019
4020
 
# File 'lib/vk/api/methods.rb', line 4014

def set_info(arguments = {})
  require "vk/api/account/methods/set_info"
  method = Methods::SetInfo.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_info_response"
  Responses::SetInfoResponse.new(response.deep_symbolize_keys)
end

#set_name_in_menu(arguments = {}) ⇒ Vk::API::Account::Responses::SetNameInMenuResponse

Returns Sets an application screen name (up to 17 characters), that is shown to the user in the left menu.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer) —

    User ID.

  • :name (String) —

    Application screen name.

Returns:

See Also:



3833
3834
3835
3836
3837
3838
3839
 
# File 'lib/vk/api/methods.rb', line 3833

def set_name_in_menu(arguments = {})
  require "vk/api/account/methods/set_name_in_menu"
  method = Methods::SetNameInMenu.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_name_in_menu_response"
  Responses::SetNameInMenuResponse.new(response.deep_symbolize_keys)
end

#set_offline(arguments = {}) ⇒ Vk::API::Account::Responses::SetOfflineResponse

Returns Marks a current user as offline.

Parameters:

  • arguments (Hash) (defaults to: {})

Returns:

See Also:



3854
3855
3856
3857
3858
3859
3860
 
# File 'lib/vk/api/methods.rb', line 3854

def set_offline(arguments = {})
  require "vk/api/account/methods/set_offline"
  method = Methods::SetOffline.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_offline_response"
  Responses::SetOfflineResponse.new(response.deep_symbolize_keys)
end

#set_online(arguments = {}) ⇒ Vk::API::Account::Responses::SetOnlineResponse

Returns Marks the current user as online for 15 minutes.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :voip (Boolean) —

    '1' if videocalls are available for current device.

Returns:

See Also:



3844
3845
3846
3847
3848
3849
3850
 
# File 'lib/vk/api/methods.rb', line 3844

def set_online(arguments = {})
  require "vk/api/account/methods/set_online"
  method = Methods::SetOnline.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_online_response"
  Responses::SetOnlineResponse.new(response.deep_symbolize_keys)
end

#set_push_settings(arguments = {}) ⇒ Vk::API::Account::Responses::SetPushSettingsResponse

Returns Change push settings.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :device_id (String) —

    Unique device ID.

  • :settings (String) —

    Push settings in a .

  • :key (String) —

    Notification key.

  • :value (Array) —

    New value for the key in a .

Returns:

See Also:



3935
3936
3937
3938
3939
3940
3941
 
# File 'lib/vk/api/methods.rb', line 3935

def set_push_settings(arguments = {})
  require "vk/api/account/methods/set_push_settings"
  method = Methods::SetPushSettings.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_push_settings_response"
  Responses::SetPushSettingsResponse.new(response.deep_symbolize_keys)
end

#set_silence_mode(arguments = {}) ⇒ Vk::API::Account::Responses::SetSilenceModeResponse

Returns Mutes push notifications for the set period of time.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :device_id (String) —

    Unique device ID.

  • :time (Integer) —

    Time in seconds for what notifications should be disabled. '-1' to disable forever.

  • :peer_id (Integer) —

    Destination ID.; "For user:; 'User ID', e.g. '12345'.; ; For chat:; '2000000000' + 'Chat ID', e.g. '2000000001'.; ; For community:; '- Community ID', e.g. '-12345'.; "

  • :sound (Integer) —

    '1' — to enable sound in this dialog, '0' — to disable sound. Only if 'peer_id' contains user or community ID.

Returns:

See Also:



3910
3911
3912
3913
3914
3915
3916
 
# File 'lib/vk/api/methods.rb', line 3910

def set_silence_mode(arguments = {})
  require "vk/api/account/methods/set_silence_mode"
  method = Methods::SetSilenceMode.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/set_silence_mode_response"
  Responses::SetSilenceModeResponse.new(response.deep_symbolize_keys)
end

#unban_user(arguments = {}) ⇒ Vk::API::Account::Responses::UnbanUserResponse

Returns Deletes user from the blacklist.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :user_id (Integer) —

    User ID.

Returns:

See Also:



3979
3980
3981
3982
3983
3984
3985
 
# File 'lib/vk/api/methods.rb', line 3979

def unban_user(arguments = {})
  require "vk/api/account/methods/unban_user"
  method = Methods::UnbanUser.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/unban_user_response"
  Responses::UnbanUserResponse.new(response.deep_symbolize_keys)
end

#unregister_device(arguments = {}) ⇒ Vk::API::Account::Responses::UnregisterDeviceResponse

Returns Unsubscribes a device from push notifications.

Parameters:

  • arguments (Hash) (defaults to: {})

Options Hash (arguments):

  • :device_id (String) —

    Unique device ID.

Returns:

See Also:



3896
3897
3898
3899
3900
3901
3902
 
# File 'lib/vk/api/methods.rb', line 3896

def unregister_device(arguments = {})
  require "vk/api/account/methods/unregister_device"
  method = Methods::UnregisterDevice.new(arguments)
  response = method.call(@client)
  require "vk/api/account/responses/unregister_device_response"
  Responses::UnregisterDeviceResponse.new(response.deep_symbolize_keys)
end