Interface ComponentOptions

The members every builder shares; they map to the members of ComponentCreate.

interface ComponentOptions {
    expiresAt?: number | Date;
    requiredCapability?: string;
    restrictedTo?: string;
    settings?: SdkSettings;
    singleUse?: boolean;
}

Properties

expiresAt?: number | Date

Expiry as Unix milliseconds or a Date; the server's default applies when left out.

requiredCapability?: string

A capability the person needs, for example approve_actions.

restrictedTo?: string

any, run_starter or owner (09 11.2).

Source of the limits (default DEFAULTS).

singleUse?: boolean

Whether using it disables the other single-use components of the message (09 11.3); the server's default applies when left out.