CheckboxGroupOption

seyfertlib/builders/CheckboxGroup.d.ts

Signature

export declare class CheckboxGroupOption

Properties

Methods

setValue
setValue(value: string): this;

Sets the value of the checkbox group option.

Parameters
value
The value of the checkbox group option.
Returns

The current CheckboxGroupOption instance.

@remarksThe 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.
setLabel
setLabel(label: string): this;

Sets the label of the checkbox group option.

Parameters
label
The label of the checkbox group option.
Returns

The current CheckboxGroupOption instance.

@remarksThe label is displayed to the user. It can be up to 100 characters long.
setDescription
setDescription(description: string): this;

Sets the description of the checkbox group option.

Parameters
description
The description of the checkbox group option.
Returns

The current CheckboxGroupOption instance.

setDefault
setDefault(value: boolean): this;

Sets whether the checkbox group option is default.

Parameters
value
Whether the checkbox group option is default.
Returns

The current CheckboxGroupOption instance.

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