com.vk.api.sdk.queries.friends

Class FriendsGetByPhonesQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetByPhonesQuery,java.util.List<GetByPhonesResponse>>

com.vk.api.sdk.queries.friends.FriendsGetByPhonesQuery

public class FriendsGetByPhonesQuery
extends AbstractQueryBuilder<FriendsGetByPhonesQuery,java.util.List<GetByPhonesResponse>>

Query for Friends.getByPhones method

Constructor Summary

Constructors

Constructor and Description
FriendsGetByPhonesQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
FriendsGetByPhonesQuery	fields(Fields... value) fields Profile fields to return.
FriendsGetByPhonesQuery	fields(java.util.List<Fields> value) Profile fields to return.
protected FriendsGetByPhonesQuery	getThis() Get reference to this object
FriendsGetByPhonesQuery	phones(java.util.List<java.lang.String> value) List of phone numbers in MSISDN format (maximum 1000).
FriendsGetByPhonesQuery	phones(java.lang.String... value) phones List of phone numbers in MSISDN format (maximum 1000).

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, getQueryHeaders, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version, withHeader, withHeaders

Methods inherited from class com.vk.api.sdk.client.ApiRequest

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FriendsGetByPhonesQuery

public FriendsGetByPhonesQuery(VkApiClient client,
                               UserActor actor)

Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

phones

public FriendsGetByPhonesQuery phones(java.lang.String... value)

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

Parameters:

value - value of "phones" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

phones

public FriendsGetByPhonesQuery phones(java.util.List<java.lang.String> value)

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

Parameters:

value - value of "phones" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public FriendsGetByPhonesQuery fields(Fields... value)

fields 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'.

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

fields

public FriendsGetByPhonesQuery fields(java.util.List<Fields> value)

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'.

Parameters:

value - value of "fields" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected FriendsGetByPhonesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsGetByPhonesQuery,java.util.List<GetByPhonesResponse>>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<FriendsGetByPhonesQuery,java.util.List<GetByPhonesResponse>>

Returns:

list of names