Package com.vk.api.sdk.queries.friends

Class FriendsSearchQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsSearchQuery,SearchResponse>

com.vk.api.sdk.queries.friends.FriendsSearchQuery

public class FriendsSearchQuery
extends AbstractQueryBuilder<FriendsSearchQuery,SearchResponse>

Query for Friends.search method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FriendsSearchQuery	count(java.lang.Integer value)	Number of friends to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
FriendsSearchQuery	fields(Fields... value)	fields Profile fields to return.
FriendsSearchQuery	fields(java.util.List<Fields> value)	Profile fields to return.
protected FriendsSearchQuery	getThis()	Get reference to this object
FriendsSearchQuery	nameCase(SearchNameCase value)	Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
FriendsSearchQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of friends.
FriendsSearchQuery	q(java.lang.String value)	Search query string (e.g., 'Vasya Babich').
protected FriendsSearchQuery	userId(int value)	User ID.

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

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

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

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

FriendsSearchQuery

public FriendsSearchQuery(VkApiClient client,
                          UserActor actor,
                          int userId)

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

Parameters:

client - VK API client

actor - actor with access token

userId - value of "user id" parameter. Minimum is 1.

Method Detail

userId

protected FriendsSearchQuery userId(int value)

User ID.

Parameters:

value - value of "user id" parameter. Minimum is 1.

Returns:

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

q

public FriendsSearchQuery q(java.lang.String value)

Search query string (e.g., 'Vasya Babich').

Parameters:

value - value of "q" parameter.

Returns:

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

nameCase

public FriendsSearchQuery nameCase(SearchNameCase value)

Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional

Parameters:

value - value of "name case" parameter. By default Nom.

Returns:

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

offset

public FriendsSearchQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of friends.

Parameters:

value - value of "offset" parameter. Minimum is 0.

Returns:

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

count

public FriendsSearchQuery count(java.lang.Integer value)

Number of friends to return.

Parameters:

value - value of "count" parameter. Maximum is 1000. Minimum is 0. By default 20.

Returns:

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

fields

public FriendsSearchQuery 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',

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public FriendsSearchQuery 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',

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected FriendsSearchQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsSearchQuery,SearchResponse>

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<FriendsSearchQuery,SearchResponse>

Returns:

list of names