com.vk.api.sdk.queries.polls

Class PollsGetByIdQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PollsGetByIdQuery,GetByIdResponse>

com.vk.api.sdk.queries.polls.PollsGetByIdQuery

public class PollsGetByIdQuery
extends AbstractQueryBuilder<PollsGetByIdQuery,GetByIdResponse>

Query for Polls.getById method

Constructor Summary

Constructors

Constructor and Description
PollsGetByIdQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PollsGetByIdQuery(VkApiClient client, UserActor actor, java.lang.Integer pollId) 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
PollsGetByIdQuery	extended(java.lang.Boolean value) Set extended
PollsGetByIdQuery	fields(java.util.List<java.lang.String> value) Set fields
PollsGetByIdQuery	fields(java.lang.String... value) fields Set fields
PollsGetByIdQuery	friendsCount(java.lang.Integer value) Set friends count
protected PollsGetByIdQuery	getThis() Get reference to this object
PollsGetByIdQuery	isBoard(java.lang.Boolean value) '1' - poll is in a board, '0' - poll is on a wall. '0' by default.
PollsGetByIdQuery	nameCase(GetByIdNameCase value) Set name case
PollsGetByIdQuery	ownerId(java.lang.Long value) ID of the user or community that owns the poll.
PollsGetByIdQuery	pollId(java.lang.Integer value) Poll 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

PollsGetByIdQuery

public PollsGetByIdQuery(VkApiClient client,
                         UserActor actor,
                         java.lang.Integer pollId)

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

pollId - value of "poll id" parameter. Minimum is 0.

PollsGetByIdQuery

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

ownerId

public PollsGetByIdQuery ownerId(java.lang.Long value)

ID of the user or community that owns the poll. Use a negative value to designate a community ID.

Parameters:

value - value of "owner id" parameter. Entity - owner

Returns:

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

isBoard

public PollsGetByIdQuery isBoard(java.lang.Boolean value)

'1' - poll is in a board, '0' - poll is on a wall. '0' by default.

Parameters:

value - value of "is board" parameter.

Returns:

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

pollId

public PollsGetByIdQuery pollId(java.lang.Integer value)

Poll ID.

Parameters:

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

Returns:

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

extended

public PollsGetByIdQuery extended(java.lang.Boolean value)

Set extended

Parameters:

value - value of "extended" parameter.

Returns:

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

friendsCount

public PollsGetByIdQuery friendsCount(java.lang.Integer value)

Set friends count

Parameters:

value - value of "friends count" parameter. Maximum is 100. Minimum is 0. By default 3.

Returns:

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

nameCase

public PollsGetByIdQuery nameCase(GetByIdNameCase value)

Set name case

Parameters:

value - value of "name case" parameter. By default nom.

Returns:

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

fields

public PollsGetByIdQuery fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public PollsGetByIdQuery fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected PollsGetByIdQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PollsGetByIdQuery,GetByIdResponse>

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<PollsGetByIdQuery,GetByIdResponse>

Returns:

list of names