com.vk.api.sdk.queries.friends

Class FriendsAddQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsAddQuery,AddResponse>

com.vk.api.sdk.queries.friends.FriendsAddQuery

public class FriendsAddQuery
extends AbstractQueryBuilder<FriendsAddQuery,AddResponse>

Query for Friends.add method

Constructor Summary

Constructors

Constructor and Description
FriendsAddQuery(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
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
FriendsAddQuery	follow(java.lang.Boolean value) '1' to pass an incoming request to followers list.
protected FriendsAddQuery	getThis() Get reference to this object
FriendsAddQuery	text(java.lang.String value) Text of the message (up to 500 characters) for the friend request, if any.
FriendsAddQuery	userId(java.lang.Long value) ID of the user whose friend request will be approved or to whom a friend request will be sent.

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

FriendsAddQuery

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

userId

public FriendsAddQuery userId(java.lang.Long value)

ID of the user whose friend request will be approved or to whom a friend request will be sent.

Parameters:

value - value of "user id" parameter. Minimum is 0. Entity - owner

Returns:

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

text

public FriendsAddQuery text(java.lang.String value)

Text of the message (up to 500 characters) for the friend request, if any.

Parameters:

value - value of "text" parameter.

Returns:

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

follow

public FriendsAddQuery follow(java.lang.Boolean value)

'1' to pass an incoming request to followers list.

Parameters:

value - value of "follow" parameter.

Returns:

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

getThis

protected FriendsAddQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsAddQuery,AddResponse>

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<FriendsAddQuery,AddResponse>

Returns:

list of names