com.vk.api.sdk.queries.friends

Class FriendsGetMutualQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetMutualQuery,java.util.List<java.lang.Long>>

com.vk.api.sdk.queries.friends.FriendsGetMutualQuery

public class FriendsGetMutualQuery
extends AbstractQueryBuilder<FriendsGetMutualQuery,java.util.List<java.lang.Long>>

Query for Friends.getMutual method

Constructor Summary

Constructors

Constructor and Description
FriendsGetMutualQuery(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
FriendsGetMutualQuery	count(java.lang.Integer value) Number of mutual friends to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected FriendsGetMutualQuery	getThis() Get reference to this object
FriendsGetMutualQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of mutual friends.
FriendsGetMutualQuery	order(java.lang.String value) Sort order: 'random' - random order
FriendsGetMutualQuery	sourceUid(java.lang.Long value) ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.
FriendsGetMutualQuery	targetUid(java.lang.Long value) ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.
FriendsGetMutualQuery	targetUids(java.util.List<java.lang.Long> value) IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.
FriendsGetMutualQuery	targetUids(java.lang.Long... value) targetUids IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.

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

FriendsGetMutualQuery

public FriendsGetMutualQuery(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

sourceUid

public FriendsGetMutualQuery sourceUid(java.lang.Long value)

ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.

Parameters:

value - value of "source uid" parameter. Minimum is 1. Entity - owner

Returns:

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

targetUid

public FriendsGetMutualQuery targetUid(java.lang.Long value)

ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.

Parameters:

value - value of "target uid" parameter. Minimum is 1. Entity - owner

Returns:

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

order

public FriendsGetMutualQuery order(java.lang.String value)

Sort order: 'random' - random order

Parameters:

value - value of "order" parameter.

Returns:

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

count

public FriendsGetMutualQuery count(java.lang.Integer value)

Number of mutual friends to return.

Parameters:

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

Returns:

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

offset

public FriendsGetMutualQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of mutual friends.

Parameters:

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

Returns:

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

targetUids

public FriendsGetMutualQuery targetUids(java.lang.Long... value)

targetUids IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.

Parameters:

value - value of "target uids" parameter.

Returns:

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

targetUids

public FriendsGetMutualQuery targetUids(java.util.List<java.lang.Long> value)

IDs of the users whose friends will be checked against the friends of the user specified in 'source_uid'.

Parameters:

value - value of "target uids" parameter.

Returns:

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

getThis

protected FriendsGetMutualQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsGetMutualQuery,java.util.List<java.lang.Long>>

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<FriendsGetMutualQuery,java.util.List<java.lang.Long>>

Returns:

list of names