com.vk.api.sdk.queries.adsweb

Class AdswebGetSitesQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdswebGetSitesQuery,GetSitesResponse>

com.vk.api.sdk.queries.adsweb.AdswebGetSitesQuery

public class AdswebGetSitesQuery
extends AbstractQueryBuilder<AdswebGetSitesQuery,GetSitesResponse>

Query for Adsweb.getSites method

Constructor Summary

Constructors

Constructor and Description
AdswebGetSitesQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
AdswebGetSitesQuery(VkApiClient client, UserActor actor, java.lang.Integer officeId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AdswebGetSitesQuery	fields(java.lang.String value) Set fields
protected AdswebGetSitesQuery	getThis() Get reference to this object
AdswebGetSitesQuery	limit(java.lang.Integer value) Set limit
AdswebGetSitesQuery	officeId(java.lang.Integer value) Set office id
AdswebGetSitesQuery	offset(java.lang.Integer value) Set offset
AdswebGetSitesQuery	sitesIds(java.lang.String value) Set sites ids

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

AdswebGetSitesQuery

public AdswebGetSitesQuery(VkApiClient client,
                           UserActor actor,
                           java.lang.Integer officeId)

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

officeId - value of "office id" parameter.

AdswebGetSitesQuery

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

officeId

public AdswebGetSitesQuery officeId(java.lang.Integer value)

Set office id

Parameters:

value - value of "office id" parameter.

Returns:

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

sitesIds

public AdswebGetSitesQuery sitesIds(java.lang.String value)

Set sites ids

Parameters:

value - value of "sites ids" parameter.

Returns:

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

fields

public AdswebGetSitesQuery fields(java.lang.String value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

limit

public AdswebGetSitesQuery limit(java.lang.Integer value)

Set limit

Parameters:

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

Returns:

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

offset

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

getThis

protected AdswebGetSitesQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdswebGetSitesQuery,GetSitesResponse>

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<AdswebGetSitesQuery,GetSitesResponse>

Returns:

list of names