Class: Vk::API::Friends::Methods::AreFriends

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

Overview

Checks the current user's friendship status with other specified users.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :user_ids (Array) —

    IDs of the users whose friendship status to check.

  • :need_sign (Boolean) —

    '1' — to return 'sign' field. 'sign' is md5("\$1id\$1_\$1user_id\$1_\$1friends_status\$1_\$1application_secret\$1"), where id is current user ID.; This field allows to check that data has not been modified by the client.; By default: '0'.




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

Instance Method Details

#need_sign ⇒ Boolean

Returns '1' — to return 'sign' field. 'sign' is md5("\$1id\$1_\$1user_id\$1_\$1friends_status\$1_\$1application_secret\$1"), where id is current user ID.; This field allows to check that data has not been modified by the client.; By default: '0'.

Returns:

  • (Boolean) —

    '1' — to return 'sign' field. 'sign' is md5("\$1id\$1_\$1user_id\$1_\$1friends_status\$1_\$1application_secret\$1"), where id is current user ID.; This field allows to check that data has not been modified by the client.; By default: '0'.



26
 
# File 'lib/vk/api/friends/methods/are_friends.rb', line 26

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

#user_ids ⇒ Array

Returns IDs of the users whose friendship status to check.

Returns:

  • (Array) —

    IDs of the users whose friendship status to check.



24
 
# File 'lib/vk/api/friends/methods/are_friends.rb', line 24

attribute :user_ids, API::Types::Coercible::Array.member(API::Types::Coercible::Int)