Class: Vk::API::Apps::Methods::Get

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

Overview

Returns applications data.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :app_id (Integer)

    Application ID

  • :app_ids (Array)

    List of application ID

  • :platform (String)

    platform. Possible values:; *'ios' — iOS;; *'android' — Android;; *'winphone' — Windows Phone;; *'web' — приложения на vk.com.; By default: 'web'.

  • :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'; (only if return_friends - 1)

  • :name_case (String)

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


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

Instance Method Details

#app_idInteger

Returns Application ID.

Returns:

  • (Integer)

    Application ID


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

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

#app_idsArray

Returns List of application ID.

Returns:

  • (Array)

    List of application ID


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

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

#fieldsArray, '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'; (only if return_friends - 1).

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'; (only if return_friends - 1)


33
# File 'lib/vk/api/apps/methods/get.rb', line 33

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

#name_caseString

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

Returns:

  • (String)

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


35
# File 'lib/vk/api/apps/methods/get.rb', line 35

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

#platformString

Returns platform. Possible values:; *'ios' — iOS;; *'android' — Android;; *'winphone' — Windows Phone;; *'web' — приложения на vk.com.; By default: 'web'.

Returns:

  • (String)

    platform. Possible values:; *'ios' — iOS;; *'android' — Android;; *'winphone' — Windows Phone;; *'web' — приложения на vk.com.; By default: 'web'.


31
# File 'lib/vk/api/apps/methods/get.rb', line 31

attribute :platform, API::Types::Coercible::String.enum("web", "ios", "android", "winphone").optional.default("web")