Package com.vk.api.sdk.queries.gifts

Class GiftsGetQuery

java.lang.Object

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

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

com.vk.api.sdk.queries.gifts.GiftsGetQuery

public class GiftsGetQuery
extends AbstractQueryBuilder<GiftsGetQuery,GetResponse>

Query for Gifts.get method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GiftsGetQuery	count(java.lang.Integer value)	Number of gifts to return.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected GiftsGetQuery	getThis()	Get reference to this object
GiftsGetQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.
GiftsGetQuery	userId(java.lang.Integer value)	User ID.

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

GiftsGetQuery

public GiftsGetQuery(VkApiClient client,
                     UserActor actor)

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

Method Detail

userId

public GiftsGetQuery userId(java.lang.Integer value)

User ID.

Parameters:

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

Returns:

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

count

public GiftsGetQuery count(java.lang.Integer value)

Number of gifts to return.

Parameters:

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

Returns:

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

offset

public GiftsGetQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

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

Returns:

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

getThis

protected GiftsGetQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<GiftsGetQuery,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<GiftsGetQuery,GetResponse>

Returns:

list of names