com.vk.api.sdk.queries.polls

Class PollsCreateQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<PollsCreateQuery,CreateResponse>

com.vk.api.sdk.queries.polls.PollsCreateQuery

public class PollsCreateQuery
extends AbstractQueryBuilder<PollsCreateQuery,CreateResponse>

Query for Polls.create method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PollsCreateQuery	addAnswers(java.lang.String value) Available answers list, for example: " ["yes","no","maybe"]", There can be from 1 to 10 answers.
PollsCreateQuery	appId(java.lang.Integer value) Set app id
PollsCreateQuery	backgroundId(CreateBackgroundId value) Set background id
PollsCreateQuery	disableUnvote(java.lang.Boolean value) Set disable unvote
PollsCreateQuery	endDate(java.lang.Integer value) Set end date
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected PollsCreateQuery	getThis() Get reference to this object
PollsCreateQuery	isAnonymous(java.lang.Boolean value) '1' - anonymous poll, participants list is hidden,, '0' - public poll, participants list is available,, Default value is '0'.
PollsCreateQuery	isMultiple(java.lang.Boolean value) Set is multiple
PollsCreateQuery	ownerId(java.lang.Long value) If a poll will be added to a communty it is required to send a negative group identifier.
PollsCreateQuery	photoId(java.lang.Integer value) Set photo id
PollsCreateQuery	question(java.lang.String value) Question text

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

PollsCreateQuery

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

question

public PollsCreateQuery question(java.lang.String value)

Question text

Parameters:

value - value of "question" parameter.

Returns:

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

isAnonymous

public PollsCreateQuery isAnonymous(java.lang.Boolean value)

'1' - anonymous poll, participants list is hidden,, '0' - public poll, participants list is available,, Default value is '0'.

Parameters:

value - value of "is anonymous" parameter.

Returns:

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

isMultiple

public PollsCreateQuery isMultiple(java.lang.Boolean value)

Set is multiple

Parameters:

value - value of "is multiple" parameter.

Returns:

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

endDate

public PollsCreateQuery endDate(java.lang.Integer value)

Set end date

Parameters:

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

Returns:

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

ownerId

public PollsCreateQuery ownerId(java.lang.Long value)

If a poll will be added to a communty it is required to send a negative group identifier. Current user by default.

Parameters:

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

Returns:

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

appId

public PollsCreateQuery appId(java.lang.Integer value)

Set app id

Parameters:

value - value of "app id" parameter.

Returns:

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

addAnswers

public PollsCreateQuery addAnswers(java.lang.String value)

Available answers list, for example: " ["yes","no","maybe"]", There can be from 1 to 10 answers.

Parameters:

value - value of "add answers" parameter.

Returns:

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

photoId

public PollsCreateQuery 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 PollsCreateQuery backgroundId(CreateBackgroundId value)

Set background id

Parameters:

value - value of "background id" parameter.

Returns:

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

disableUnvote

public PollsCreateQuery disableUnvote(java.lang.Boolean value)

Set disable unvote

Parameters:

value - value of "disable unvote" parameter.

Returns:

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

getThis

protected PollsCreateQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<PollsCreateQuery,CreateResponse>

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<PollsCreateQuery,CreateResponse>

Returns:

list of names