Class CheckboxGroupOption

constructor

• new CheckboxGroupOption(data: APICheckboxGroupOption): CheckboxGroupOption

  Parameters

  • data: APICheckboxGroupOption

  Returns CheckboxGroupOption

data

setDefault

• setDefault(value: boolean): CheckboxGroupOption

  Sets whether the checkbox group option is default.

  Parameters

  • value: boolean

    Whether the checkbox group option is default.

  Returns CheckboxGroupOption

  The current CheckboxGroupOption instance.

setDescription

• setDescription(description: string): CheckboxGroupOption

  Sets the description of the checkbox group option.

  Parameters

  • description: string

    The description of the checkbox group option.

  Returns CheckboxGroupOption

  The current CheckboxGroupOption instance.

setLabel

• setLabel(label: string): CheckboxGroupOption

  Sets the label of the checkbox group option.

  Parameters

  • label: string

    The label of the checkbox group option.

  Returns CheckboxGroupOption

  The current CheckboxGroupOption instance.

  Remarks

  The label is displayed to the user. It can be up to 100 characters long.

setValue

• setValue(value: string): CheckboxGroupOption

  Sets the value of the checkbox group option.

  Parameters

  • value: string

    The value of the checkbox group option.

  Returns CheckboxGroupOption

  The current CheckboxGroupOption instance.

  Remarks

  The value is sent to the bot when the option is selected. It must be unique within the options of the checkbox group. The value can be up to 100 characters long.

toJSON

• toJSON(): {
      default?: boolean;
      description?: string;
      label: string;
      value: string;
  }

  Returns { default?: boolean; description?: string; label: string; value: string }

  • Optionaldefault?: boolean

    Shows the option as selected by default

  • Optionaldescription?: string

    Additional description of the option; max 100 characters

  • label: string

    User-facing name of the option; max 100 characters

  • value: string

    Dev-defined value of the option; max 100 characters