com.vk.api.sdk.queries.apps

Class AppsGetFriendsListQueryWithExtended

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AppsGetFriendsListQueryWithExtended,GetFriendsListExtendedResponse>

com.vk.api.sdk.queries.apps.AppsGetFriendsListQueryWithExtended

public class AppsGetFriendsListQueryWithExtended
extends AbstractQueryBuilder<AppsGetFriendsListQueryWithExtended,GetFriendsListExtendedResponse>

Query for Apps.getFriendsList method

Constructor Summary

Constructors

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

AppsGetFriendsListQueryWithExtended

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

protected AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended 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 AppsGetFriendsListQueryWithExtended getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AppsGetFriendsListQueryWithExtended,GetFriendsListExtendedResponse>

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<AppsGetFriendsListQueryWithExtended,GetFriendsListExtendedResponse>

Returns:

list of names