Package com.vk.api.sdk.queries.polls

Class PollsGetVotersQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PollsGetVotersQuery,java.util.List<GetVotersResponse>>

com.vk.api.sdk.queries.polls.PollsGetVotersQuery

public class PollsGetVotersQuery
extends AbstractQueryBuilder<PollsGetVotersQuery,java.util.List<GetVotersResponse>>

Query for Polls.getVoters method

Constructor Summary

Constructors

Constructor	Description
PollsGetVotersQuery(VkApiClient client, UserActor actor, int pollId, java.lang.Integer... answerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
PollsGetVotersQuery(VkApiClient client, UserActor actor, int pollId, java.util.List<java.lang.Integer> answerIds)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected PollsGetVotersQuery	answerIds(java.lang.Integer... value)	answer_ids Answer IDs.
protected PollsGetVotersQuery	answerIds(java.util.List<java.lang.Integer> value)	Answer IDs.
PollsGetVotersQuery	count(java.lang.Integer value)	Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000', otherwise '10').
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
PollsGetVotersQuery	fields(Fields... value)	fields Profile fields to return.
PollsGetVotersQuery	fields(java.util.List<Fields> value)	Profile fields to return.
PollsGetVotersQuery	friendsOnly(java.lang.Boolean value)	'1' — to return only current user's friends, '0' — to return all users (default),
protected PollsGetVotersQuery	getThis()	Get reference to this object
PollsGetVotersQuery	isBoard(java.lang.Boolean value)	Set is board
PollsGetVotersQuery	nameCase(GetVotersNameCase value)	Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional
PollsGetVotersQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of voters.
PollsGetVotersQuery	ownerId(java.lang.Integer value)	ID of the user or community that owns the poll.
protected PollsGetVotersQuery	pollId(int value)	Poll 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

PollsGetVotersQuery

public PollsGetVotersQuery(VkApiClient client,
                           UserActor actor,
                           int pollId,
                           java.lang.Integer... answerIds)

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

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

answerIds - value of "answer ids" parameter.

PollsGetVotersQuery

public PollsGetVotersQuery(VkApiClient client,
                           UserActor actor,
                           int pollId,
                           java.util.List<java.lang.Integer> answerIds)

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

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

answerIds - value of "answer ids" parameter.

Method Detail

ownerId

public PollsGetVotersQuery ownerId(java.lang.Integer 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.

Returns:

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

pollId

protected PollsGetVotersQuery pollId(int 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.

isBoard

public PollsGetVotersQuery isBoard(java.lang.Boolean value)

Set is board

Parameters:

value - value of "is board" parameter.

Returns:

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

friendsOnly

public PollsGetVotersQuery friendsOnly(java.lang.Boolean value)

'1' — to return only current user's friends, '0' — to return all users (default),

Parameters:

value - value of "friends only" parameter.

Returns:

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

offset

public PollsGetVotersQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of voters. '0' — (default)

Parameters:

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

Returns:

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

count

public PollsGetVotersQuery count(java.lang.Integer value)

Number of user IDs to return (if the 'friends_only' parameter is not set, maximum '1000', otherwise '10'). '100' — (default)

Parameters:

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

Returns:

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

nameCase

public PollsGetVotersQuery nameCase(GetVotersNameCase value)

Case for declension of user name and surname: , 'nom' — nominative (default) , 'gen' — genitive , 'dat' — dative , 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional

Parameters:

value - value of "name case" parameter.

Returns:

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

answerIds

protected PollsGetVotersQuery answerIds(java.lang.Integer... value)

answer_ids Answer IDs.

Parameters:

value - value of "answer ids" parameter.

Returns:

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

answerIds

protected PollsGetVotersQuery answerIds(java.util.List<java.lang.Integer> value)

Answer IDs.

Parameters:

value - value of "answer ids" parameter.

Returns:

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

fields

public PollsGetVotersQuery fields(Fields... value)

fields Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

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

Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate (birthdate)', 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'rate', 'contacts', 'education', 'online', 'counters'.

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected PollsGetVotersQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PollsGetVotersQuery,java.util.List<GetVotersResponse>>

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<PollsGetVotersQuery,java.util.List<GetVotersResponse>>

Returns:

list of names