Class: Vk::API::Friends::Methods::GetRequests

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

Overview

Returns information about the current user's incoming and outgoing friend requests.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Friends::Methods::GetRequests

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :offset (Integer) —

    Offset needed to return a specific subset of friend requests.

  • :count (Integer) —

    Number of friend requests to return (default 100, maximum 1000).

  • :extended (Boolean) —

    '1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends

  • :need_mutual (Boolean) —

    '1' — to return a list of mutual friends (up to 20), if any

  • :out (Boolean) —

    '1' — to return outgoing requests; '0' — to return incoming requests (default)

  • :sort (Integer) —

    Sort order:; '1' — by number of mutual friends; '0' — by date

  • :suggested (Boolean) —

    '1' — to return a list of suggested friends; '0' — to return friend requests (default)




# File 'lib/vk/api/friends/methods/get_requests.rb', line 15

Instance Method Details

#count ⇒ Integer

Returns Number of friend requests to return (default 100, maximum 1000).

Returns:

  • (Integer) —

    Number of friend requests to return (default 100, maximum 1000).



31
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 31

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

#extended ⇒ Boolean

Returns '1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends.

Returns:

  • (Boolean) —

    '1' — to return response messages from users who have sent a friend request or, if 'suggested' is set to '1', to return a list of suggested friends



33
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 33

attribute :extended, API::Types::Form::Bool.optional.default(nil)

#need_mutual ⇒ Boolean

Returns '1' — to return a list of mutual friends (up to 20), if any.

Returns:

  • (Boolean) —

    '1' — to return a list of mutual friends (up to 20), if any



35
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 35

attribute :need_mutual, API::Types::Form::Bool.optional.default(nil)

#offset ⇒ Integer

Returns Offset needed to return a specific subset of friend requests.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of friend requests.



29
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 29

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

#out ⇒ Boolean

Returns '1' — to return outgoing requests; '0' — to return incoming requests (default).

Returns:

  • (Boolean) —

    '1' — to return outgoing requests; '0' — to return incoming requests (default)



37
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 37

attribute :out, API::Types::Form::Bool.optional.default(nil)

#sort ⇒ Integer

Returns Sort order:; '1' — by number of mutual friends; '0' — by date.

Returns:

  • (Integer) —

    Sort order:; '1' — by number of mutual friends; '0' — by date



39
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 39

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

#suggested ⇒ Boolean

Returns '1' — to return a list of suggested friends; '0' — to return friend requests (default).

Returns:

  • (Boolean) —

    '1' — to return a list of suggested friends; '0' — to return friend requests (default)



41
 
# File 'lib/vk/api/friends/methods/get_requests.rb', line 41

attribute :suggested, API::Types::Form::Bool.optional.default(nil)