Package io.getstream.chat.java.models

Class Poll

java.lang.Object

io.getstream.chat.java.models.Poll

public class Poll
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Poll.PollCreateRequestData
static class	Poll.PollCreateResponse
static class	Poll.PollDeleteRequest
static class	Poll.PollDeleteResponse
static class	Poll.PollGetRequest
static class	Poll.PollGetResponse
static class	Poll.PollOption
static class	Poll.PollOptionCreateRequestData
static class	Poll.PollOptionCreateResponse
static class	Poll.PollOptionDeleteRequest
static class	Poll.PollOptionDeleteResponse
static class	Poll.PollOptionGetRequest
static class	Poll.PollOptionGetResponse
static class	Poll.PollOptionUpdateRequestData
static class	Poll.PollOptionUpdateResponse
static class	Poll.PollQueryRequestData
static class	Poll.PollQueryResponse
static class	Poll.PollUpdatePartialRequestData
static class	Poll.PollUpdatePartialResponse
static class	Poll.PollUpdateRequestData
static class	Poll.PollUpdateResponse
static class	Poll.PollVote
static class	Poll.PollVoteCastRequestData
static class	Poll.PollVoteCastResponse
static class	Poll.PollVoteDeleteRequest
static class	Poll.PollVoteDeleteResponse
static class	Poll.PollVoteQueryRequestData
static class	Poll.PollVoteQueryResponse
static class	Poll.VotingVisibility

Constructor Summary

Constructors

Constructor	Description
Poll()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
static @NotNull Poll.PollVoteCastRequestData.PollVoteCastRequest	castVote(@NotNull java.lang.String messageId, @NotNull java.lang.String pollId)	Creates a cast vote request
static @NotNull Poll.PollCreateRequestData.PollCreateRequest	create()	Creates a create request
static @NotNull Poll.PollOptionCreateRequestData.PollOptionCreateRequest	createOption(@NotNull java.lang.String pollId)	Creates a create option request
static @NotNull Poll.PollDeleteRequest	delete(@NotNull java.lang.String pollId)	Creates a delete request
static @NotNull Poll.PollOptionDeleteRequest	deleteOption(@NotNull java.lang.String pollId, @NotNull java.lang.String optionId)	Creates a delete option request
static @NotNull Poll.PollVoteDeleteRequest	deleteVote(@NotNull java.lang.String messageId, @NotNull java.lang.String pollId, @NotNull java.lang.String voteId)	Creates a delete vote request
boolean	equals(java.lang.Object o)
static @NotNull Poll.PollGetRequest	get(@NotNull java.lang.String pollId)	Creates a get request
@NotNull java.lang.Boolean	getAllowAnswers()
@NotNull java.lang.Boolean	getAllowUserSuggestedOptions()
@Nullable java.lang.Integer	getAnswersCount()
@NotNull java.util.Date	getCreatedAt()
@Nullable User	getCreatedBy()
@NotNull java.lang.String	getCreatedById()
@Nullable java.util.Map<java.lang.String,java.lang.Object>	getCustom()
@Nullable java.lang.String	getDescription()
@NotNull java.lang.Boolean	getEnforceUniqueVote()
@NotNull java.lang.String	getId()
@NotNull java.lang.Boolean	getIsClosed()
@Nullable java.util.List<Poll.PollVote>	getLatestAnswers()
@Nullable java.util.Map<java.lang.String,java.util.List<Poll.PollVote>>	getLatestVotesByOption()
@Nullable java.lang.Integer	getMaxVotesAllowed()
@NotNull java.lang.String	getName()
static @NotNull Poll.PollOptionGetRequest	getOption(@NotNull java.lang.String pollId, @NotNull java.lang.String optionId)	Creates a get option request
@Nullable java.util.List<Poll.PollOption>	getOptions()
@Nullable java.util.List<Poll.PollVote>	getOwnVotes()
@NotNull java.util.Date	getUpdatedAt()
@Nullable java.lang.Integer	getVoteCount()
@Nullable java.util.Map<java.lang.String,java.lang.Integer>	getVoteCountsByOption()
@Nullable Poll.VotingVisibility	getVotingVisibility()
int	hashCode()
static @NotNull Poll.PollQueryRequestData.PollQueryRequest	query()	Creates a query request
static @NotNull Poll.PollVoteQueryRequestData.PollVoteQueryRequest	queryVotes(@NotNull java.lang.String pollId)	Creates a query votes request
void	setAllowAnswers(@NotNull java.lang.Boolean allowAnswers)
void	setAllowUserSuggestedOptions(@NotNull java.lang.Boolean allowUserSuggestedOptions)
void	setAnswersCount(@Nullable java.lang.Integer answersCount)
void	setCreatedAt(@NotNull java.util.Date createdAt)
void	setCreatedBy(@Nullable User createdBy)
void	setCreatedById(@NotNull java.lang.String createdById)
void	setCustom(@Nullable java.util.Map<java.lang.String,java.lang.Object> custom)
void	setDescription(@Nullable java.lang.String description)
void	setEnforceUniqueVote(@NotNull java.lang.Boolean enforceUniqueVote)
void	setId(@NotNull java.lang.String id)
void	setIsClosed(@NotNull java.lang.Boolean isClosed)
void	setLatestAnswers(@Nullable java.util.List<Poll.PollVote> latestAnswers)
void	setLatestVotesByOption(@Nullable java.util.Map<java.lang.String,java.util.List<Poll.PollVote>> latestVotesByOption)
void	setMaxVotesAllowed(@Nullable java.lang.Integer maxVotesAllowed)
void	setName(@NotNull java.lang.String name)
void	setOptions(@Nullable java.util.List<Poll.PollOption> options)
void	setOwnVotes(@Nullable java.util.List<Poll.PollVote> ownVotes)
void	setUpdatedAt(@NotNull java.util.Date updatedAt)
void	setVoteCount(@Nullable java.lang.Integer voteCount)
void	setVoteCountsByOption(@Nullable java.util.Map<java.lang.String,java.lang.Integer> voteCountsByOption)
void	setVotingVisibility(@Nullable Poll.VotingVisibility votingVisibility)
java.lang.String	toString()
static @NotNull Poll.PollUpdateRequestData.PollUpdateRequest	update(@NotNull java.lang.String pollId)	Creates an update request
static @NotNull Poll.PollOptionUpdateRequestData.PollOptionUpdateRequest	updateOption(@NotNull java.lang.String pollId)	Creates an update option request
static @NotNull Poll.PollUpdatePartialRequestData.PollUpdatePartialRequest	updatePartial(@NotNull java.lang.String pollId)	Creates a partial update request

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Poll

public Poll()

Method Detail

create

@NotNull
public static @NotNull Poll.PollCreateRequestData.PollCreateRequest create()

Creates a create request

Returns:

the created request

get

@NotNull
public static @NotNull Poll.PollGetRequest get(@NotNull
                                               @NotNull java.lang.String pollId)

Creates a get request

Parameters:

pollId - the poll id

Returns:

the created request

update

@NotNull
public static @NotNull Poll.PollUpdateRequestData.PollUpdateRequest update(@NotNull
                                                                           @NotNull java.lang.String pollId)

Creates an update request

Parameters:

pollId - the poll id

Returns:

the created request

updatePartial

@NotNull
public static @NotNull Poll.PollUpdatePartialRequestData.PollUpdatePartialRequest updatePartial(@NotNull
                                                                                                @NotNull java.lang.String pollId)

Creates a partial update request

Parameters:

pollId - the poll id

Returns:

the created request

delete

@NotNull
public static @NotNull Poll.PollDeleteRequest delete(@NotNull
                                                     @NotNull java.lang.String pollId)

Creates a delete request

Parameters:

pollId - the poll id

Returns:

the created request

query

@NotNull
public static @NotNull Poll.PollQueryRequestData.PollQueryRequest query()

Creates a query request

Returns:

the created request

createOption

@NotNull
public static @NotNull Poll.PollOptionCreateRequestData.PollOptionCreateRequest createOption(@NotNull
                                                                                             @NotNull java.lang.String pollId)

Creates a create option request

Parameters:

pollId - the poll id

Returns:

the created request

getOption

@NotNull
public static @NotNull Poll.PollOptionGetRequest getOption(@NotNull
                                                           @NotNull java.lang.String pollId,
                                                           @NotNull
                                                           @NotNull java.lang.String optionId)

Creates a get option request

Parameters:

pollId - the poll id

optionId - the option id

Returns:

the created request

updateOption

@NotNull
public static @NotNull Poll.PollOptionUpdateRequestData.PollOptionUpdateRequest updateOption(@NotNull
                                                                                             @NotNull java.lang.String pollId)

Creates an update option request

Parameters:

pollId - the poll id

Returns:

the created request

deleteOption

@NotNull
public static @NotNull Poll.PollOptionDeleteRequest deleteOption(@NotNull
                                                                 @NotNull java.lang.String pollId,
                                                                 @NotNull
                                                                 @NotNull java.lang.String optionId)

Creates a delete option request

Parameters:

pollId - the poll id

optionId - the option id

Returns:

the created request

queryVotes

@NotNull
public static @NotNull Poll.PollVoteQueryRequestData.PollVoteQueryRequest queryVotes(@NotNull
                                                                                     @NotNull java.lang.String pollId)

Creates a query votes request

Parameters:

pollId - the poll id

Returns:

the created request

castVote

@NotNull
public static @NotNull Poll.PollVoteCastRequestData.PollVoteCastRequest castVote(@NotNull
                                                                                 @NotNull java.lang.String messageId,
                                                                                 @NotNull
                                                                                 @NotNull java.lang.String pollId)

Creates a cast vote request

Parameters:

messageId - the message id

pollId - the poll id

Returns:

the created request

deleteVote

@NotNull
public static @NotNull Poll.PollVoteDeleteRequest deleteVote(@NotNull
                                                             @NotNull java.lang.String messageId,
                                                             @NotNull
                                                             @NotNull java.lang.String pollId,
                                                             @NotNull
                                                             @NotNull java.lang.String voteId)

Creates a delete vote request

Parameters:

messageId - the message id

pollId - the poll id

voteId - the vote id

Returns:

the created request

getId

@NotNull
public @NotNull java.lang.String getId()

getName

@NotNull
public @NotNull java.lang.String getName()

getDescription

@Nullable
public @Nullable java.lang.String getDescription()

getVotingVisibility

@Nullable
public @Nullable Poll.VotingVisibility getVotingVisibility()

getEnforceUniqueVote

@NotNull
public @NotNull java.lang.Boolean getEnforceUniqueVote()

getMaxVotesAllowed

@Nullable
public @Nullable java.lang.Integer getMaxVotesAllowed()

getAllowUserSuggestedOptions

@NotNull
public @NotNull java.lang.Boolean getAllowUserSuggestedOptions()

getAllowAnswers

@NotNull
public @NotNull java.lang.Boolean getAllowAnswers()

getIsClosed

@NotNull
public @NotNull java.lang.Boolean getIsClosed()

getOptions

@Nullable
public @Nullable java.util.List<Poll.PollOption> getOptions()

getVoteCount

@Nullable
public @Nullable java.lang.Integer getVoteCount()

getVoteCountsByOption

@Nullable
public @Nullable java.util.Map<java.lang.String,java.lang.Integer> getVoteCountsByOption()

getAnswersCount

@Nullable
public @Nullable java.lang.Integer getAnswersCount()

getLatestVotesByOption

@Nullable
public @Nullable java.util.Map<java.lang.String,java.util.List<Poll.PollVote>> getLatestVotesByOption()

getLatestAnswers

@Nullable
public @Nullable java.util.List<Poll.PollVote> getLatestAnswers()

getOwnVotes

@Nullable
public @Nullable java.util.List<Poll.PollVote> getOwnVotes()

getCreatedById

@NotNull
public @NotNull java.lang.String getCreatedById()

getCreatedBy

@Nullable
public @Nullable User getCreatedBy()

getCreatedAt

@NotNull
public @NotNull java.util.Date getCreatedAt()

getUpdatedAt

@NotNull
public @NotNull java.util.Date getUpdatedAt()

getCustom

@Nullable
public @Nullable java.util.Map<java.lang.String,java.lang.Object> getCustom()

setId

public void setId(@NotNull
                  @NotNull java.lang.String id)

setName

public void setName(@NotNull
                    @NotNull java.lang.String name)

setDescription

public void setDescription(@Nullable
                           @Nullable java.lang.String description)

setVotingVisibility

public void setVotingVisibility(@Nullable
                                @Nullable Poll.VotingVisibility votingVisibility)

setEnforceUniqueVote

public void setEnforceUniqueVote(@NotNull
                                 @NotNull java.lang.Boolean enforceUniqueVote)

setMaxVotesAllowed

public void setMaxVotesAllowed(@Nullable
                               @Nullable java.lang.Integer maxVotesAllowed)

setAllowUserSuggestedOptions

public void setAllowUserSuggestedOptions(@NotNull
                                         @NotNull java.lang.Boolean allowUserSuggestedOptions)

setAllowAnswers

public void setAllowAnswers(@NotNull
                            @NotNull java.lang.Boolean allowAnswers)

setIsClosed

public void setIsClosed(@NotNull
                        @NotNull java.lang.Boolean isClosed)

setOptions

public void setOptions(@Nullable
                       @Nullable java.util.List<Poll.PollOption> options)

setVoteCount

public void setVoteCount(@Nullable
                         @Nullable java.lang.Integer voteCount)

setVoteCountsByOption

public void setVoteCountsByOption(@Nullable
                                  @Nullable java.util.Map<java.lang.String,java.lang.Integer> voteCountsByOption)

setAnswersCount

public void setAnswersCount(@Nullable
                            @Nullable java.lang.Integer answersCount)

setLatestVotesByOption

public void setLatestVotesByOption(@Nullable
                                   @Nullable java.util.Map<java.lang.String,java.util.List<Poll.PollVote>> latestVotesByOption)

setLatestAnswers

public void setLatestAnswers(@Nullable
                             @Nullable java.util.List<Poll.PollVote> latestAnswers)

setOwnVotes

public void setOwnVotes(@Nullable
                        @Nullable java.util.List<Poll.PollVote> ownVotes)

setCreatedById

public void setCreatedById(@NotNull
                           @NotNull java.lang.String createdById)

setCreatedBy

public void setCreatedBy(@Nullable
                         @Nullable User createdBy)

setCreatedAt

public void setCreatedAt(@NotNull
                         @NotNull java.util.Date createdAt)

setUpdatedAt

public void setUpdatedAt(@NotNull
                         @NotNull java.util.Date updatedAt)

setCustom

public void setCustom(@Nullable
                      @Nullable java.util.Map<java.lang.String,java.lang.Object> custom)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object