com.vk.api.sdk.queries.widgets

Class WidgetsGetPagesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<WidgetsGetPagesQuery,GetPagesResponse>

com.vk.api.sdk.queries.widgets.WidgetsGetPagesQuery

public class WidgetsGetPagesQuery
extends AbstractQueryBuilder<WidgetsGetPagesQuery,GetPagesResponse>

Query for Widgets.getPages method

Constructor Summary

Constructors

Constructor and Description
WidgetsGetPagesQuery(VkApiClient client, ServiceActor actor) Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters
WidgetsGetPagesQuery(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
WidgetsGetPagesQuery	count(java.lang.Integer value) Set count
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected WidgetsGetPagesQuery	getThis() Get reference to this object
WidgetsGetPagesQuery	offset(java.lang.Integer value) Set offset
WidgetsGetPagesQuery	order(java.lang.String value) Set order
WidgetsGetPagesQuery	period(java.lang.String value) Set period
WidgetsGetPagesQuery	widgetApiId(java.lang.Integer value) Set widget api 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

WidgetsGetPagesQuery

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

WidgetsGetPagesQuery

public WidgetsGetPagesQuery(VkApiClient client,
                            ServiceActor actor)

Creates a AbstractQueryBuilder instance that can be used to build service api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

Method Detail

widgetApiId

public WidgetsGetPagesQuery widgetApiId(java.lang.Integer value)

Set widget api id

Parameters:

value - value of "widget api id" parameter.

Returns:

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

order

public WidgetsGetPagesQuery order(java.lang.String value)

Set order

Parameters:

value - value of "order" parameter. By default friend_likes.

Returns:

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

period

public WidgetsGetPagesQuery period(java.lang.String value)

Set period

Parameters:

value - value of "period" parameter. By default week.

Returns:

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

offset

public WidgetsGetPagesQuery 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.

count

public WidgetsGetPagesQuery count(java.lang.Integer value)

Set count

Parameters:

value - value of "count" parameter. Maximum is 200. Minimum is 10. By default 10.

Returns:

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

getThis

protected WidgetsGetPagesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<WidgetsGetPagesQuery,GetPagesResponse>

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<WidgetsGetPagesQuery,GetPagesResponse>

Returns:

list of names