useCreatePoll

Introduction

The useCreatePoll hook is used to create a poll conversation object through the implementation of poll creation dialog. You can use this hook to create a custom UI for poll creation dialog box.

Property	Type	Description	Optional
pollOptions	PollOption[]	The list of options available in the poll.	❌
addPollOption	ZeroArgVoidReturns	Adds a new option to the poll.	❌
updatePollOption	TwoArgVoidReturns<string, number>	Updates a specific poll option by index.	❌
removePollOption	OneArgVoidReturns	Removes a poll option by index.	❌
createPollConversation	ZeroArgVoidReturns	Creates a new poll conversation.	❌
changePollText	OneArgVoidReturns <React.ChangeEvent<HTMLTextAreaElementS> S>	Updates the poll question text.	❌
pollText	string	The text of the poll question.	❌
updatePollExpirationDate	OneArgVoidReturns number | null	Updates the expiration date of the poll.	❌
pollExpirationDate	number | null	The expiration date of the poll (timestamp), or null.	❌
advancedOptions	AdvancedPollOptions	Configuration options for advanced poll settings.	❌
updateAdvancedOptions	OneArgVoidReturns React.ChangeEvent<HTMLInputElementS> | SelectChangeEvent<numberS>	Updates advanced poll settings based on user input.	❌

PollOption

Property	Type	Description	Optional
text	string	The text of the poll option.	❌

AdvancedPollOptions

Property	Type	Description	Optional
ALLOW_VOTERS_TO_ADD_OPTIONS	boolean	Allows voters to add new options to the poll.	❌
ALLOW_ANONYMOUS_VOTING	boolean	Enables anonymous voting in the poll.	❌
SHOW_LIVE_RESULTS	boolean	Displays live results as votes are cast.	❌
MULTIPLE_SELECTION_STATE	number	Defines the state for multiple selection.	❌
MULTIPLE_SELECTION_NO	number	The number of selections allowed per voter.	❌

Reference

For reference checkout this file