Class: Vk::API::Users::Methods::Get

Inherits:
Schema::Method show all
Defined in:
lib/vk/api/users/methods/get.rb

Overview

Returns detailed information on users.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Users::Methods::Get

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_ids (Array) —

    User IDs or screen names ('screen_name'). By default, current user ID.

  • :fields (Array, 'bdate') —

    Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities';

  • :name_case (String) —

    Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive ; 'dat' — dative; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional




# File 'lib/vk/api/users/methods/get.rb', line 15

Instance Method Details

#fields ⇒ Array, 'bdate'

Returns Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities';.

Returns:

  • (Array, 'bdate') —

    Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities';



27
 
# File 'lib/vk/api/users/methods/get.rb', line 27

attribute :fields, API::Types::Coercible::Array.member(API::Types::Coercible::String).optional.default(nil)

#name_case ⇒ String

Returns Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive ; 'dat' — dative; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional.

Returns:

  • (String) —

    Case for declension of user name and surname:; 'nom' — nominative (default); 'gen' — genitive ; 'dat' — dative; 'acc' — accusative ; 'ins' — instrumental ; 'abl' — prepositional



29
 
# File 'lib/vk/api/users/methods/get.rb', line 29

attribute :name_case, API::Types::Coercible::String.enum("nom", "gen", "dat", "acc", "ins", "abl").optional.default(nil)

#user_ids ⇒ Array

Returns User IDs or screen names ('screen_name'). By default, current user ID.

Returns:

  • (Array) —

    User IDs or screen names ('screen_name'). By default, current user ID.



25
 
# File 'lib/vk/api/users/methods/get.rb', line 25

attribute :user_ids, API::Types::Coercible::Array.member(API::Types::Coercible::String).constrained(max_size: 1000).optional.default(nil)