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

Class FriendsEditListQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FriendsEditListQuery,OkResponse>

com.vk.api.sdk.queries.friends.FriendsEditListQuery

public class FriendsEditListQuery
extends AbstractQueryBuilder<FriendsEditListQuery,OkResponse>

Query for Friends.editList method

Constructor Summary

Constructors

Constructor	Description
FriendsEditListQuery(VkApiClient client, UserActor actor, int listId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
FriendsEditListQuery	addUserIds(java.lang.Integer... value)	add_user_ids (Applies if 'user_ids' parameter is not set.), User IDs to add to the friend list.
FriendsEditListQuery	addUserIds(java.util.List<java.lang.Integer> value)	(Applies if 'user_ids' parameter is not set.), User IDs to add to the friend list.
FriendsEditListQuery	deleteUserIds(java.lang.Integer... value)	delete_user_ids (Applies if 'user_ids' parameter is not set.), User IDs to delete from the friend list.
FriendsEditListQuery	deleteUserIds(java.util.List<java.lang.Integer> value)	(Applies if 'user_ids' parameter is not set.), User IDs to delete from the friend list.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected FriendsEditListQuery	getThis()	Get reference to this object
protected FriendsEditListQuery	listId(int value)	Friend list ID.
FriendsEditListQuery	name(java.lang.String value)	Name of the friend list.
FriendsEditListQuery	userIds(java.lang.Integer... value)	user_ids IDs of users in the friend list.
FriendsEditListQuery	userIds(java.util.List<java.lang.Integer> value)	IDs of users in the friend list.

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

FriendsEditListQuery

public FriendsEditListQuery(VkApiClient client,
                            UserActor actor,
                            int listId)

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

listId - value of "list id" parameter. Minimum is 0.

Method Detail

name

public FriendsEditListQuery name(java.lang.String value)

Name of the friend list.

Parameters:

value - value of "name" parameter.

Returns:

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

listId

protected FriendsEditListQuery listId(int value)

Friend list ID.

Parameters:

value - value of "list id" parameter. Minimum is 0.

Returns:

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

userIds

public FriendsEditListQuery userIds(java.lang.Integer... value)

user_ids IDs of users in the friend list.

Parameters:

value - value of "user ids" parameter.

Returns:

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

userIds

public FriendsEditListQuery userIds(java.util.List<java.lang.Integer> value)

IDs of users in the friend list.

Parameters:

value - value of "user ids" parameter.

Returns:

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

addUserIds

public FriendsEditListQuery addUserIds(java.lang.Integer... value)

add_user_ids (Applies if 'user_ids' parameter is not set.), User IDs to add to the friend list.

Parameters:

value - value of "add user ids" parameter.

Returns:

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

addUserIds

public FriendsEditListQuery addUserIds(java.util.List<java.lang.Integer> value)

(Applies if 'user_ids' parameter is not set.), User IDs to add to the friend list.

Parameters:

value - value of "add user ids" parameter.

Returns:

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

deleteUserIds

public FriendsEditListQuery deleteUserIds(java.lang.Integer... value)

delete_user_ids (Applies if 'user_ids' parameter is not set.), User IDs to delete from the friend list.

Parameters:

value - value of "delete user ids" parameter.

Returns:

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

deleteUserIds

public FriendsEditListQuery deleteUserIds(java.util.List<java.lang.Integer> value)

(Applies if 'user_ids' parameter is not set.), User IDs to delete from the friend list.

Parameters:

value - value of "delete user ids" parameter.

Returns:

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

getThis

protected FriendsEditListQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FriendsEditListQuery,OkResponse>

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<FriendsEditListQuery,OkResponse>

Returns:

list of names