seyfert/lib/builders/Checkbox.d.ts

The most advanced framework for discord bots

import { type APICheckboxComponent } from '../types';
import { BaseComponentBuilder } from './Base';
export declare class Checkbox extends BaseComponentBuilder<APICheckboxComponent> {
    constructor(data?: Partial<APICheckboxComponent>);
    /**
     * Sets the ID for the checkbox.
     * @param id - The ID for the checkbox.
     * @returns The current Checkbox instance.
     * @remarks The ID is used by Discord to identify the component when an interaction is received. It must be unique within the message.
     */
    setId(id: number): this;
    /**
     * Sets the custom ID for the checkbox.
     * @param customId - The custom ID for the checkbox.
     * @returns The current Checkbox instance.
     */
    setCustomId(customId: string): this;
    /**
     * Sets whether the checkbox is selected by default.
     * @param value - Whether the checkbox is selected by default.
     * @return The current Checkbox instance.
     */
    setDefault(value: boolean): this;
}