Module it.auties.cobalt

Package it.auties.whatsapp.model.message.standard

Class PollCreationMessage

java.lang.Object

it.auties.whatsapp.model.message.standard.PollCreationMessage

All Implemented Interfaces:

it.auties.protobuf.model.ProtobufMessage, it.auties.protobuf.model.ProtobufObject, ContextualMessage<PollCreationMessage>, Message

public final class PollCreationMessage
extends Object
implements ContextualMessage<PollCreationMessage>

A model class that represents a message holding a poll inside

Field Summary

Fields

Modifier and Type	Field	Description
private ContextInfo	contextInfo
private byte[]	encryptionKey
private final List<PollOption>	selectableOptions
private final int	selectableOptionsCount
(package private) final Map<String,PollOption>	selectableOptionsMap
(package private) final List<SelectedPollOption>	selectedOptions
private final String	title

Constructor Summary

Constructors

Constructor	Description
PollCreationMessage(byte[] encryptionKey, String title, List<PollOption> selectableOptions, int selectableOptionsCount, ContextInfo contextInfo, Map<String,PollOption> selectableOptionsMap, List<SelectedPollOption> selectedOptions)

Method Summary

Modifier and Type	Method	Description
void	addSelectableOption(String hash, PollOption option)
void	addSelectedOptions(JidProvider voter, Collection<PollOption> voted)
MessageCategory	category()	Return message category
Optional<ContextInfo>	contextInfo()
Optional<byte[]>	encryptionKey()
Optional<PollOption>	getSelectableOption(String hash)
Collection<SelectedPollOption>	getSelectedOptions(JidProvider voter)	Returns an unmodifiable list of the options that a contact voted in this poll
List<PollOption>	selectableOptions()
int	selectableOptionsCount()
PollCreationMessage	setContextInfo(ContextInfo contextInfo)
void	setEncryptionKey(byte[] encryptionKey)
(package private) static PollCreationMessage	simpleBuilder(String title, List<PollOption> selectableOptions)	Constructs a new builder to create a PollCreationMessage The newsletters can be later sent using Whatsapp.sendMessage(ChatMessageInfo)
String	title()
MessageType	type()	Return message type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

encryptionKey

private byte[] encryptionKey

title

private final String title

selectableOptions

private final List<PollOption> selectableOptions

selectableOptionsCount

private final int selectableOptionsCount

contextInfo

private ContextInfo contextInfo

selectableOptionsMap

final Map<String,PollOption> selectableOptionsMap

selectedOptions

final List<SelectedPollOption> selectedOptions

Constructor Details

PollCreationMessage

public PollCreationMessage(byte[] encryptionKey,
 String title,
 List<PollOption> selectableOptions,
 int selectableOptionsCount,
 ContextInfo contextInfo,
 Map<String,PollOption> selectableOptionsMap,
 List<SelectedPollOption> selectedOptions)

Method Details

simpleBuilder

static PollCreationMessage simpleBuilder(String title,
 List<PollOption> selectableOptions)

Constructs a new builder to create a PollCreationMessage The newsletters can be later sent using Whatsapp.sendMessage(ChatMessageInfo)

Parameters:

title - the non-null title of the poll

selectableOptions - the null-null non-empty options of the poll

Returns:

a non-null new message

getSelectedOptions

public Collection<SelectedPollOption> getSelectedOptions(JidProvider voter)

Returns an unmodifiable list of the options that a contact voted in this poll

Parameters:

voter - the non-null contact that voted in this poll

Returns:

a non-null unmodifiable map

addSelectedOptions

public void addSelectedOptions(JidProvider voter,
 Collection<PollOption> voted)

addSelectableOption

public void addSelectableOption(String hash,
 PollOption option)

getSelectableOption

public Optional<PollOption> getSelectableOption(String hash)

type

public MessageType type()

Description copied from interface: Message

Return message type

Specified by:

type in interface Message

Returns:

a non-null message type

category

public MessageCategory category()

Description copied from interface: Message

Return message category

Specified by:

category in interface Message

Returns:

a non-null message category

title

public String title()

selectableOptions

public List<PollOption> selectableOptions()

selectableOptionsCount

public int selectableOptionsCount()

encryptionKey

public Optional<byte[]> encryptionKey()

setEncryptionKey

public void setEncryptionKey(byte[] encryptionKey)

contextInfo

public Optional<ContextInfo> contextInfo()

Specified by:

contextInfo in interface ContextualMessage<PollCreationMessage>

setContextInfo

public PollCreationMessage setContextInfo(ContextInfo contextInfo)

Specified by:

setContextInfo in interface ContextualMessage<PollCreationMessage>