Class: Vk::API::Friends::Methods::GetByPhones

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

Overview

Returns a list of the current user's friends whose phone numbers, validated or specified in a profile, are in a given list.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

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

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :phones (Array)

    List of phone numbers in MSISDN format (maximum 1000).; Example:; "+79219876543,+79111234567"

  • :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', 'rate', 'contacts', 'education', 'online, counters'.;


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

Instance Method Details

#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', 'rate', 'contacts', 'education', 'online, counters'.;.

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', 'rate', 'contacts', 'education', 'online, counters'.;


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

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

#phonesArray

Returns List of phone numbers in MSISDN format (maximum 1000).; Example:; "+79219876543,+79111234567".

Returns:

  • (Array)

    List of phone numbers in MSISDN format (maximum 1000).; Example:; "+79219876543,+79111234567"


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

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