Class: Vk::API::Account::Methods::LookupContacts

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

Overview

Allows to search the VK users using phone numbers, e-mail addresses and user IDs on other services.

Arguments collapse

Instance Method Summary collapse

Methods inherited from Schema::Method

#call, #method, #to_hash

Constructor Details

#initialize(arguments) ⇒ Account::Methods::LookupContacts

Parameters:

  • arguments (Hash)

Options Hash (arguments):

  • :contacts (Array) —

    List of contacts separated with commas

  • :service (String) —

    String identifier of a service which contacts are used for searching. Possible values: ; * email; * phone; * twitter; * facebook; * odnoklassniki; * instagram; * google

  • :mycontact (String) —

    Contact of a current user on a specified service

  • :return_all (Boolean) —

    '1' – also return contacts found using this service before, '0' – return only contacts found using 'contacts' field.

  • :fields (Array) —

    Profile fields to return. Possible values: 'nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities'.




# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 15

Instance Method Details

#contacts ⇒ Array

Returns List of contacts separated with commas.

Returns:

  • (Array) —

    List of contacts separated with commas



27
 
# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 27

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

#fields ⇒ Array

Returns Profile fields to return. Possible values: 'nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities'.

Returns:

  • (Array) —

    Profile fields to return. Possible values: 'nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities'.



35
 
# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 35

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

#mycontact ⇒ String

Returns Contact of a current user on a specified service.

Returns:

  • (String) —

    Contact of a current user on a specified service



31
 
# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 31

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

#return_all ⇒ Boolean

Returns '1' – also return contacts found using this service before, '0' – return only contacts found using 'contacts' field.

Returns:

  • (Boolean) —

    '1' – also return contacts found using this service before, '0' – return only contacts found using 'contacts' field.



33
 
# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 33

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

#service ⇒ String

Returns String identifier of a service which contacts are used for searching. Possible values: ; * email; * phone; * twitter; * facebook; * odnoklassniki; * instagram; * google.

Returns:

  • (String) —

    String identifier of a service which contacts are used for searching. Possible values: ; * email; * phone; * twitter; * facebook; * odnoklassniki; * instagram; * google



29
 
# File 'lib/vk/api/account/methods/lookup_contacts.rb', line 29

attribute :service, API::Types::Coercible::String