com.vk.api.sdk.queries.fave

Class FaveGetQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<FaveGetQuery,GetResponse>

com.vk.api.sdk.queries.fave.FaveGetQuery

public class FaveGetQuery
extends AbstractQueryBuilder<FaveGetQuery,GetResponse>

Query for Fave.get method

Constructor Summary

Constructors

Constructor and Description
FaveGetQuery(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
FaveGetQuery	count(java.lang.Integer value) Number of users to return.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
FaveGetQuery	extended(java.lang.Boolean value) '1' - to return additional 'wall', 'profiles', and 'groups' fields.
FaveGetQuery	fields(Fields... value) fields Set fields
FaveGetQuery	fields(java.util.List<Fields> value) Set fields
protected FaveGetQuery	getThis() Get reference to this object
FaveGetQuery	isFromSnackbar(java.lang.Boolean value) Set is from snackbar
FaveGetQuery	itemType(GetItemType value) Set item type
FaveGetQuery	offset(java.lang.Integer value) Offset needed to return a specific subset of users.
FaveGetQuery	tagId(java.lang.Integer value) Tag ID.

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

FaveGetQuery

public FaveGetQuery(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 FaveGetQuery extended(java.lang.Boolean value)

'1' - to return additional 'wall', 'profiles', and 'groups' fields. By default: '0'.

Parameters:

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

Returns:

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

itemType

public FaveGetQuery itemType(GetItemType value)

Set item type

Parameters:

value - value of "item type" parameter.

Returns:

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

tagId

public FaveGetQuery tagId(java.lang.Integer value)

Tag ID.

Parameters:

value - value of "tag id" parameter.

Returns:

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

offset

public FaveGetQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of users.

Parameters:

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

Returns:

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

count

public FaveGetQuery count(java.lang.Integer value)

Number of users to return.

Parameters:

value - value of "count" parameter. Maximum is 100. Minimum is 1. By default 50.

Returns:

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

isFromSnackbar

public FaveGetQuery isFromSnackbar(java.lang.Boolean value)

Set is from snackbar

Parameters:

value - value of "is from snackbar" parameter.

Returns:

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

fields

public FaveGetQuery fields(Fields... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected FaveGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<FaveGetQuery,GetResponse>

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<FaveGetQuery,GetResponse>

Returns:

list of names