com.vk.api.sdk.queries.apps

Class AppsGetFriendsListQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetFriendsListQuery,GetFriendsListResponse>

com.vk.api.sdk.queries.apps.AppsGetFriendsListQuery

public class AppsGetFriendsListQuery
extends AbstractQueryBuilder<AppsGetFriendsListQuery,GetFriendsListResponse>

Query for Apps.getFriendsList method

Constructor Summary

Constructors

Constructor and Description
AppsGetFriendsListQuery(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
AppsGetFriendsListQuery	count(java.lang.Integer value) List size.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AppsGetFriendsListQuery	extended(java.lang.Boolean value) Set extended
AppsGetFriendsListQuery	fields(Fields... value) fields Additional profile fields, see [vk.com/dev/fields|description].
AppsGetFriendsListQuery	fields(java.util.List<Fields> value) Additional profile fields, see [vk.com/dev/fields|description].
protected AppsGetFriendsListQuery	getThis() Get reference to this object
AppsGetFriendsListQuery	offset(java.lang.Integer value) Set offset
AppsGetFriendsListQuery	query(java.lang.String value) Search query string (e.g., 'Vasya Babich').
AppsGetFriendsListQuery	type(GetFriendsListType value) List type.

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

AppsGetFriendsListQuery

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

extended

public AppsGetFriendsListQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter. By default 0.

Returns:

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

count

public AppsGetFriendsListQuery count(java.lang.Integer value)

List size.

Parameters:

value - value of "count" parameter. Maximum is 5000. Minimum is 0. By default 20.

Returns:

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

offset

public AppsGetFriendsListQuery offset(java.lang.Integer value)

Set offset

Parameters:

value - value of "offset" parameter. Minimum is 0. By default 0.

Returns:

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

type

public AppsGetFriendsListQuery type(GetFriendsListType value)

List type. Possible values: * 'invite' - available for invites (don't play the game),, * 'request' - available for request (play the game). By default: 'invite'.

Parameters:

value - value of "type" parameter. By default invite.

Returns:

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

query

public AppsGetFriendsListQuery query(java.lang.String value)

Search query string (e.g., 'Vasya Babich').

Parameters:

value - value of "query" parameter.

Returns:

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

fields

public AppsGetFriendsListQuery fields(Fields... value)

fields Additional profile fields, see [vk.com/dev/fields|description].

Parameters:

value - value of "fields" parameter. By default [photo_200].

Returns:

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

fields

public AppsGetFriendsListQuery fields(java.util.List<Fields> value)

Additional profile fields, see [vk.com/dev/fields|description].

Parameters:

value - value of "fields" parameter. By default [photo_200].

Returns:

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

getThis

protected AppsGetFriendsListQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetFriendsListQuery,GetFriendsListResponse>

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<AppsGetFriendsListQuery,GetFriendsListResponse>

Returns:

list of names