com.vk.api.sdk.queries.friends

Class FriendsAreFriendsQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsAreFriendsQueryWithExtended,java.util.List<AreFriendsExtendedResponse>>

com.vk.api.sdk.queries.friends.FriendsAreFriendsQueryWithExtended

public class FriendsAreFriendsQueryWithExtended
extends AbstractQueryBuilder<FriendsAreFriendsQueryWithExtended,java.util.List<AreFriendsExtendedResponse>>

Query for Friends.areFriends method

Constructor Summary

Constructors

Constructor and Description
FriendsAreFriendsQueryWithExtended(VkApiClient client, UserActor actor, java.util.List<java.lang.Long> userIds) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
FriendsAreFriendsQueryWithExtended(VkApiClient client, UserActor actor, java.lang.Long... userIds) 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
protected FriendsAreFriendsQueryWithExtended	extended(java.lang.Boolean value) Return friend request read_state field
protected FriendsAreFriendsQueryWithExtended	getThis() Get reference to this object
FriendsAreFriendsQueryWithExtended	needSign(java.lang.Boolean value) '1' - to return 'sign' field.
FriendsAreFriendsQueryWithExtended	userIds(java.util.List<java.lang.Long> value) IDs of the users whose friendship status to check.
FriendsAreFriendsQueryWithExtended	userIds(java.lang.Long... value) userIds 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, 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

FriendsAreFriendsQueryWithExtended

public FriendsAreFriendsQueryWithExtended(VkApiClient client,
                                          UserActor actor,
                                          java.lang.Long... userIds)

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

userIds - value of "user ids" parameter.

FriendsAreFriendsQueryWithExtended

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

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

userIds - value of "user ids" parameter.

Method Detail

needSign

public FriendsAreFriendsQueryWithExtended 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

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

public FriendsAreFriendsQueryWithExtended userIds(java.lang.Long... value)

userIds 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

public FriendsAreFriendsQueryWithExtended userIds(java.util.List<java.lang.Long> 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 FriendsAreFriendsQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsAreFriendsQueryWithExtended,java.util.List<AreFriendsExtendedResponse>>

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<FriendsAreFriendsQueryWithExtended,java.util.List<AreFriendsExtendedResponse>>

Returns:

list of names