com.vk.api.sdk.queries.friends

Class FriendsGetMutualQueryWithTargetUids

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsGetMutualQueryWithTargetUids,java.util.List<GetMutualTargetUidsResponse>>

com.vk.api.sdk.queries.friends.FriendsGetMutualQueryWithTargetUids

public class FriendsGetMutualQueryWithTargetUids
extends AbstractQueryBuilder<FriendsGetMutualQueryWithTargetUids,java.util.List<GetMutualTargetUidsResponse>>

Query for Friends.getMutual method

Constructor Summary

Constructors

Constructor and Description
FriendsGetMutualQueryWithTargetUids(VkApiClient client, UserActor actor, java.util.List<java.lang.Long> targetUids) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
FriendsGetMutualQueryWithTargetUids(VkApiClient client, UserActor actor, java.lang.Long... targetUids) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
FriendsGetMutualQueryWithTargetUids	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 FriendsGetMutualQueryWithTargetUids	getThis() Get reference to this object
FriendsGetMutualQueryWithTargetUids	offset(java.lang.Integer value) Offset needed to return a specific subset of mutual friends.
FriendsGetMutualQueryWithTargetUids	order(java.lang.String value) Sort order: 'random' - random order
FriendsGetMutualQueryWithTargetUids	sourceUid(java.lang.Long value) ID of the user whose friends will be checked against the friends of the user specified in 'target_uid'.
FriendsGetMutualQueryWithTargetUids	targetUid(java.lang.Long value) ID of the user whose friends will be checked against the friends of the user specified in 'source_uid'.
protected FriendsGetMutualQueryWithTargetUids	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'.
protected FriendsGetMutualQueryWithTargetUids	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

FriendsGetMutualQueryWithTargetUids

public FriendsGetMutualQueryWithTargetUids(VkApiClient client,
                                           UserActor actor,
                                           java.lang.Long... targetUids)

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

FriendsGetMutualQueryWithTargetUids

public FriendsGetMutualQueryWithTargetUids(VkApiClient client,
                                           UserActor actor,
                                           java.util.List<java.lang.Long> targetUids)

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 FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids 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

protected FriendsGetMutualQueryWithTargetUids 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

protected FriendsGetMutualQueryWithTargetUids 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 FriendsGetMutualQueryWithTargetUids getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsGetMutualQueryWithTargetUids,java.util.List<GetMutualTargetUidsResponse>>

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<FriendsGetMutualQueryWithTargetUids,java.util.List<GetMutualTargetUidsResponse>>

Returns:

list of names