Class Poll

constructor

• new Poll(client: any): Poll

  Parameters

  • client: any

  Returns Poll

Static ReadonlyMAX_NAME_LENGTH

Static ReadonlyMAX_OPTION_LENGTH

Static ReadonlyMAX_OPTIONS

addOption

• addOption(name: string): this

  Rejects duplicates (votes are keyed by option text) and enforces MAX_OPTIONS.

  Parameters

  • name: string

  Returns this

addOptions

• addOptions(names: string[]): this

  Parameters

  • names: string[]

  Returns this

assertValid

• assertValid(): this

  Throw on the first validation problem.

  Returns this

build

• build(): { poll: Record<string, any> }

  Requires a name + at least 2 unique options; runs assertValid() first.

  Returns { poll: Record<string, any> }

clearOptions

• clearOptions(): this

  Drop every option and the quiz answer.

  Returns this

countOptions

• countOptions(): number

  How many options have been added.

  Returns number

getOptions

• getOptions(): string[]

  A copy of the options added so far.

  Returns string[]

removeOption

• removeOption(name: string): this

  Remove one option by exact text (clears the quiz answer if it pointed at it).

  Parameters

  • name: string

  Returns this

send

• send(jid: string, options?: Record<string, any>): Promise<any>

  Build and send via the socket's sendMessage().

  Parameters

  • jid: string
  • Optionaloptions: Record<string, any>

  Returns Promise<any>

setAnnouncementGroup

• setAnnouncementGroup(isAnnouncement?: boolean): this

  Parameters

  • OptionalisAnnouncement: boolean

  Returns this

setCanAddOption

• setCanAddOption(allow?: boolean): this

  Parameters

  • Optionalallow: boolean

  Returns this

setEndDate

• setEndDate(date: string | number | Date): this

  Throws on an unparseable date instead of shipping endTime: NaN.

  Parameters

  • date: string | number | Date

  Returns this

setHideVoter

• setHideVoter(hide?: boolean): this

  Parameters

  • Optionalhide: boolean

  Returns this

setMessageSecret

• setMessageSecret(secret: Uint8Array): this

  Pin the 32-byte poll messageSecret (otherwise the socket mints a random one).

  Parameters

  • secret: Uint8Array

  Returns this

setMultiSelect

• setMultiSelect(canSelectMultiple?: boolean): this

  Parameters

  • OptionalcanSelectMultiple: boolean

  Returns this

setName

• setName(name: string): this

  Parameters

  • name: string

  Returns this

setOptions

• setOptions(names: string[]): this

  Replace every option at once; rolls back on error.

  Parameters

  • names: string[]

  Returns this

setQuiz

• setQuiz(correctOptionName: string): this

  Quiz mode — must match one of the added options exactly.

  Parameters

  • correctOptionName: string

  Returns this

setSelectable

• setSelectable(count: number): this

  Parameters

  • count: number

  Returns this

toJSON

• toJSON(): { poll: Record<string, any> }

  Alias of build().

  Returns { poll: Record<string, any> }

validate

• validate(): string[]

  Every problem with the current state; empty when safe to send.

  Returns string[]