Class: Vk::API::Apps::Methods::GetFriendsList

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

Overview

Creates friends list for requests and invites in current app.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :count (Integer)

    List size.

  • :type (String)

    List type. Possible values:; * 'invite' — available for invites (don't play the game);; * 'request' — available for request (play the game).; ; By default: 'invite'.

  • :fields (Array)

    Additional profile fields, see .


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

Instance Method Details

#countInteger

Returns List size.

Returns:

  • (Integer)

    List size.


25
# File 'lib/vk/api/apps/methods/get_friends_list.rb', line 25

attribute :count, API::Types::Coercible::Int.optional.default(20)

#fieldsArray

Returns Additional profile fields, see .

Returns:

  • (Array)

    Additional profile fields, see .


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

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

#typeString

Returns List type. Possible values:; * 'invite' — available for invites (don't play the game);; * 'request' — available for request (play the game).; ; By default: 'invite'.

Returns:

  • (String)

    List type. Possible values:; * 'invite' — available for invites (don't play the game);; * 'request' — available for request (play the game).; ; By default: 'invite'.


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

attribute :type, API::Types::Coercible::String.enum("request", "invite").optional.default("request")