com.vk.api.sdk.queries.polls

Class PollsGetVotersQueryWithFields

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PollsGetVotersQueryWithFields,java.util.List<GetVotersFieldsResponse>>

com.vk.api.sdk.queries.polls.PollsGetVotersQueryWithFields

public class PollsGetVotersQueryWithFields
extends AbstractQueryBuilder<PollsGetVotersQueryWithFields,java.util.List<GetVotersFieldsResponse>>

Query for Polls.getVoters method

Constructor Summary

Constructors

Constructor and Description
PollsGetVotersQueryWithFields(VkApiClient client, UserActor actor, java.lang.Integer pollId, java.util.List<java.lang.Long> answerIds, java.util.List<Fields> fields) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
PollsGetVotersQueryWithFields(VkApiClient client, UserActor actor, java.lang.Integer pollId, java.lang.Long[] answerIds, Fields... fields) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

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

PollsGetVotersQueryWithFields

public PollsGetVotersQueryWithFields(VkApiClient client,
                                     UserActor actor,
                                     java.lang.Integer pollId,
                                     java.lang.Long[] answerIds,
                                     Fields... fields)

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.

answerIds - value of "answer ids" parameter.

PollsGetVotersQueryWithFields

public PollsGetVotersQueryWithFields(VkApiClient client,
                                     UserActor actor,
                                     java.lang.Integer pollId,
                                     java.util.List<java.lang.Long> answerIds,
                                     java.util.List<Fields> fields)

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.

answerIds - value of "answer ids" parameter.

Method Detail

ownerId

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

pollId

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

isBoard

public PollsGetVotersQueryWithFields 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 PollsGetVotersQueryWithFields 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 PollsGetVotersQueryWithFields 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 PollsGetVotersQueryWithFields 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 PollsGetVotersQueryWithFields nameCase(NameCase 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

public PollsGetVotersQueryWithFields answerIds(java.lang.Long... value)

answerIds Answer IDs.

Parameters:

value - value of "answer ids" parameter.

Returns:

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

answerIds

public PollsGetVotersQueryWithFields answerIds(java.util.List<java.lang.Long> value)

Answer IDs.

Parameters:

value - value of "answer ids" parameter.

Returns:

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

fields

protected PollsGetVotersQueryWithFields 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

protected PollsGetVotersQueryWithFields 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 PollsGetVotersQueryWithFields getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PollsGetVotersQueryWithFields,java.util.List<GetVotersFieldsResponse>>

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<PollsGetVotersQueryWithFields,java.util.List<GetVotersFieldsResponse>>

Returns:

list of names