Class: Vk::API::Friends::Methods::GetMutual

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

Overview

Returns a list of user IDs of the mutual friends of two users.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :source_uid (Integer) —

    ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.

  • :target_uid (Integer) —

    ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.

  • :target_uids (Array) —

    IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.

  • :order (String) —

    Sort order:; 'random' — random order

  • :count (Integer) —

    Number of mutual friends to return.

  • :offset (Integer) —

    Offset needed to return a specific subset of mutual friends.




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

Instance Method Details

#count ⇒ Integer

Returns Number of mutual friends to return.

Returns:

  • (Integer) —

    Number of mutual friends to return.



36
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 36

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

#offset ⇒ Integer

Returns Offset needed to return a specific subset of mutual friends.

Returns:

  • (Integer) —

    Offset needed to return a specific subset of mutual friends.



38
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 38

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

#order ⇒ String

Returns Sort order:; 'random' — random order.

Returns:

  • (String) —

    Sort order:; 'random' — random order



34
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 34

attribute :order, API::Types::Coercible::String.optional.default(nil)

#source_uid ⇒ Integer

Returns ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.

Returns:

  • (Integer) —

    ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.



28
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 28

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

#target_uid ⇒ Integer

Returns ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.

Returns:

  • (Integer) —

    ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.



30
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 30

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

#target_uids ⇒ Array

Returns IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.

Returns:

  • (Array) —

    IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.



32
 
# File 'lib/vk/api/friends/methods/get_mutual.rb', line 32

attribute :target_uids, API::Types::Coercible::Array.member(API::Types::Coercible::Int).optional.default(nil)