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

Class FriendsAreFriendsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsAreFriendsQuery,java.util.List<AreFriendsResponse>>

com.vk.api.sdk.queries.friends.FriendsAreFriendsQuery

public class FriendsAreFriendsQuery
extends AbstractQueryBuilder<FriendsAreFriendsQuery,java.util.List<AreFriendsResponse>>

Query for Friends.areFriends method

Constructor Summary

Constructors

Constructor	Description
FriendsAreFriendsQuery(VkApiClient client, UserActor actor, java.lang.Integer... userIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
FriendsAreFriendsQuery(VkApiClient client, UserActor actor, java.util.List<java.lang.Integer> userIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
FriendsAreFriendsQuery	extended(java.lang.Boolean value)	Return friend request read_state field
protected FriendsAreFriendsQuery	getThis()	Get reference to this object
FriendsAreFriendsQuery	needSign(java.lang.Boolean value)	'1' — to return 'sign' field.
protected FriendsAreFriendsQuery	userIds(java.lang.Integer... value)	user_ids IDs of the users whose friendship status to check.
protected FriendsAreFriendsQuery	userIds(java.util.List<java.lang.Integer> value)	IDs of the users whose friendship status to check.

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

FriendsAreFriendsQuery

public FriendsAreFriendsQuery(VkApiClient client,
                              UserActor actor,
                              java.lang.Integer... userIds)

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

userIds - value of "user ids" parameter.

FriendsAreFriendsQuery

public FriendsAreFriendsQuery(VkApiClient client,
                              UserActor actor,
                              java.util.List<java.lang.Integer> userIds)

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

userIds - value of "user ids" parameter.

Method Detail

needSign

public FriendsAreFriendsQuery needSign(java.lang.Boolean value)

'1' — to return 'sign' field. 'sign' is md5("{id}_{user_id}_{friends_status}_{application_secret}"), where id is current user ID. This field allows to check that data has not been modified by the client. By default: '0'.

Parameters:

value - value of "need sign" parameter.

Returns:

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

extended

public FriendsAreFriendsQuery extended(java.lang.Boolean value)

Return friend request read_state field

Parameters:

value - value of "extended" parameter.

Returns:

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

userIds

protected FriendsAreFriendsQuery userIds(java.lang.Integer... value)

user_ids IDs of the users whose friendship status to check.

Parameters:

value - value of "user ids" parameter.

Returns:

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

userIds

protected FriendsAreFriendsQuery userIds(java.util.List<java.lang.Integer> value)

IDs of the users whose friendship status to check.

Parameters:

value - value of "user ids" parameter.

Returns:

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

getThis

protected FriendsAreFriendsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsAreFriendsQuery,java.util.List<AreFriendsResponse>>

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<FriendsAreFriendsQuery,java.util.List<AreFriendsResponse>>

Returns:

list of names