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

Class PollsEditQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PollsEditQuery,OkResponse>

com.vk.api.sdk.queries.polls.PollsEditQuery

public class PollsEditQuery
extends AbstractQueryBuilder<PollsEditQuery,OkResponse>

Query for Polls.edit method

Constructor Summary

Constructors

Constructor	Description
PollsEditQuery(VkApiClient client, UserActor actor, int pollId)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
PollsEditQuery	addAnswers(java.lang.String value)	Answers list, for example: , "["yes","no","maybe"]"
PollsEditQuery	backgroundId(EditBackgroundId value)	Set background id
PollsEditQuery	deleteAnswers(java.lang.String value)	List of answer ids to be deleted.
PollsEditQuery	editAnswers(java.lang.String value)	Object containing answers that need to be edited,, key - answer id, value - new answer text.
PollsEditQuery	endDate(java.lang.Integer value)	Set end date
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected PollsEditQuery	getThis()	Get reference to this object
PollsEditQuery	ownerId(java.lang.Integer value)	Poll owner id
PollsEditQuery	photoId(java.lang.Integer value)	Set photo id
protected PollsEditQuery	pollId(int value)	Edited poll's id
PollsEditQuery	question(java.lang.String value)	New question text

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

PollsEditQuery

public PollsEditQuery(VkApiClient client,
                      UserActor actor,
                      int pollId)

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.

Method Detail

ownerId

public PollsEditQuery ownerId(java.lang.Integer value)

Poll owner id

Parameters:

value - value of "owner id" parameter.

Returns:

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

pollId

protected PollsEditQuery pollId(int value)

Edited poll's id

Parameters:

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

Returns:

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

question

public PollsEditQuery question(java.lang.String value)

New question text

Parameters:

value - value of "question" parameter.

Returns:

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

addAnswers

public PollsEditQuery addAnswers(java.lang.String value)

Answers list, for example: , "["yes","no","maybe"]"

Parameters:

value - value of "add answers" parameter.

Returns:

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

editAnswers

public PollsEditQuery editAnswers(java.lang.String value)

Object containing answers that need to be edited,, key - answer id, value - new answer text. Example: {"382967099":"option1", "382967103":"option2"}"

Parameters:

value - value of "edit answers" parameter.

Returns:

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

deleteAnswers

public PollsEditQuery deleteAnswers(java.lang.String value)

List of answer ids to be deleted. For example: "[382967099, 382967103]"

Parameters:

value - value of "delete answers" parameter.

Returns:

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

endDate

public PollsEditQuery endDate(java.lang.Integer value)

Set end date

Parameters:

value - value of "end date" parameter. Minimum is 0.

Returns:

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

photoId

public PollsEditQuery photoId(java.lang.Integer value)

Set photo id

Parameters:

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

Returns:

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

backgroundId

public PollsEditQuery backgroundId(EditBackgroundId value)

Set background id

Parameters:

value - value of "background id" parameter.

Returns:

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

getThis

protected PollsEditQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PollsEditQuery,OkResponse>

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<PollsEditQuery,OkResponse>

Returns:

list of names