Package 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 Description PollsCreateQuery(VkApiClient client, UserActor actor)Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PollsCreateQueryaddAnswers(java.lang.String value)Available answers list, for example: " ["yes","no","maybe"]", There can be from 1 to 10 answers.PollsCreateQueryappId(java.lang.Integer value)Set app idPollsCreateQuerybackgroundId(CreateBackgroundId value)Set background idPollsCreateQuerydisableUnvote(java.lang.Boolean value)Set disable unvotePollsCreateQueryendDate(java.lang.Integer value)Set end dateprotected java.util.List<java.lang.String>essentialKeys()Get list of required parameter namesprotected PollsCreateQuerygetThis()Get reference to this objectPollsCreateQueryisAnonymous(java.lang.Boolean value)'1' - anonymous poll, participants list is hidden,, '0' - public poll, participants list is available,, Default value is '0'.PollsCreateQueryisMultiple(java.lang.Boolean value)Set is multiplePollsCreateQueryownerId(java.lang.Integer value)If a poll will be added to a communty it is required to send a negative group identifier.PollsCreateQueryphotoId(java.lang.Integer value)Set photo idPollsCreateQueryquestion(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, 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
-
-
-
-
Constructor Detail
-
PollsCreateQuery
public PollsCreateQuery(VkApiClient client, UserActor actor)
Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters- Parameters:
client- VK API clientactor- 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
ownerId
public PollsCreateQuery ownerId(java.lang.Integer 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.- Returns:
- a reference to this
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject 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
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
getThis
protected PollsCreateQuery getThis()
Description copied from class:AbstractQueryBuilderGet reference to this object- Specified by:
getThisin classAbstractQueryBuilder<PollsCreateQuery,CreateResponse>- Returns:
- a reference to this
AbstractQueryBuilderobject to fulfill the "Builder" pattern.
-
essentialKeys
protected java.util.List<java.lang.String> essentialKeys()
Description copied from class:AbstractQueryBuilderGet list of required parameter names- Specified by:
essentialKeysin classAbstractQueryBuilder<PollsCreateQuery,CreateResponse>- Returns:
- list of names
-
-