nodes/generated

Interface DiscordV2NodeParameters

Source
interface DiscordV2NodeParameters {
    after?: string;
    approvalOptions?: {
        values: {
            approvalType?: "single" | "double";
            approveLabel?: string;
            disapproveLabel?: string;
        };
    };
    authentication?: "oAuth2"
    | "webhook"
    | "botToken";
    channelId?: {
        mode: "id" | "list" | "url";
        value: string;
    };
    content?: string;
    defineForm?: "json"
    | "fields";
    embeds?: {
        values: {
            author?: string;
            color?: string;
            description?: string;
            image?: string;
            inputMethod?: "json" | "fields";
            json?: string;
            thumbnail?: string;
            timestamp?: string;
            title?: string;
            url?: string;
            video?: string;
        }[];
    };
    emoji?: string;
    files?: { values: { inputFieldName?: string }[] };
    formFields?: {
        values: {
            acceptFileTypes?: string;
            elementName?: string;
            fieldLabel: string;
            fieldName?: string;
            fieldOptions: { values: { option?: string }[] };
            fieldType:
                | "number"
                | "file"
                | "text"
                | "email"
                | "date"
                | "html"
                | "checkbox"
                | "dropdown"
                | "hiddenField"
                | "password"
                | "radio"
                | "textarea";
            fieldValue?: string;
            formatDate?: string;
            html?: string;
            limitSelection?: "exact"
            | "range"
            | "unlimited";
            maxSelections?: number;
            minSelections?: number;
            multipleFiles?: boolean;
            multiselect?: boolean;
            multiselectLegacyNotice?: string;
            numberOfSelections?: number;
            placeholder?: string;
            requiredField?: boolean;
        }[];
    };
    guildId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    jsonOutput?: string;
    limit?: number;
    message?: string;
    messageId?: string;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "send"
    | "deleteMessage"
    | "react"
    | "sendAndWait"
    | "deleteChannel"
    | "roleAdd"
    | "roleRemove"
    | "sendLegacy";
    options?: | { simplify?: boolean }
    | {
        flags?: (
            "SUPPRESS_EMBEDS"
            | "SUPPRESS_NOTIFICATIONS"
        )[];
        message_reference?: string;
        tts?: boolean;
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    }
    | {
        bitrate?: number;
        categoryId?: {
            mode: "id"
            | "list"
            | "url";
            value: string;
        };
        nsfw?: boolean;
        position?: number;
        rate_limit_per_user?: number;
        topic?: string;
        user_limit?: number;
    }
    | { filter?: (0 | 2 | 4)[] }
    | {
        avatar_url?: string;
        flags?: ("SUPPRESS_EMBEDS" | "SUPPRESS_NOTIFICATIONS")[];
        tts?: boolean;
        username?: string;
        wait?: boolean;
    };
    resource?: "message"
    | "member"
    | "channel";
    responseType?: "approval" | "freeText" | "customForm";
    returnAll?: boolean;
    role?: unknown[];
    sendTo?: "user" | "channel";
    type?: "2" | "4" | "0";
    userId?: { mode: "id" | "list"; value: string };
}

Properties§

Source§

readonly after?: string

The ID of the user after which to return the members

Source§

readonly approvalOptions?: {
    values: {
        approvalType?: "single" | "double";
        approveLabel?: string;
        disapproveLabel?: string;
    };
}

Default: {}

Source§

readonly authentication?: "oAuth2" | "webhook" | "botToken"

Default: "botToken"

Source§

readonly channelId?: { mode: "id" | "list" | "url"; value: string }

Select the channel by name, URL, or ID Default: {"mode":"list","value":""}

Source§

readonly content?: string

The content of the message (up to 2000 characters) Type options: {"rows":2}

Source§

readonly defineForm?: "json" | "fields"

Default: "fields"

Source§

readonly embeds?: {
    values: {
        author?: string;
        color?: string;
        description?: string;
        image?: string;
        inputMethod?: "json" | "fields";
        json?: string;
        thumbnail?: string;
        timestamp?: string;
        title?: string;
        url?: string;
        video?: string;
    }[];
}

Default: [] Type options: {"multipleValues":true}

Source§

readonly emoji?: string

The emoji you want to react with

Source§

readonly files?: { values: { inputFieldName?: string }[] }

Default: [] Type options: {"multipleValues":true}

Source§

readonly formFields?: {
    values: {
        acceptFileTypes?: string;
        elementName?: string;
        fieldLabel: string;
        fieldName?: string;
        fieldOptions: { values: { option?: string }[] };
        fieldType:
            | "number"
            | "file"
            | "text"
            | "email"
            | "date"
            | "html"
            | "checkbox"
            | "dropdown"
            | "hiddenField"
            | "password"
            | "radio"
            | "textarea";
        fieldValue?: string;
        formatDate?: string;
        html?: string;
        limitSelection?: "exact"
        | "range"
        | "unlimited";
        maxSelections?: number;
        minSelections?: number;
        multipleFiles?: boolean;
        multiselect?: boolean;
        multiselectLegacyNotice?: string;
        numberOfSelections?: number;
        placeholder?: string;
        requiredField?: boolean;
    }[];
}

Default: {} Type options: {"multipleValues":true,"sortable":true}

Source§

readonly guildId?: { mode: "id" | "list" | "url"; value: string }

Select the server (guild) that your bot is connected to Default: {"mode":"list","value":""}

Source§

readonly jsonOutput?: string

Default: "[\n {\n "fieldLabel":"Name",\n "placeholder":"enter you name",\n "requiredField":true\n },\n {\n "fieldLabel":"Age",\n "fieldType":"number",\n "placeholder":"enter your age"\n },\n {\n "fieldLabel":"Email",\n "fieldType":"email",\n "requiredField":true\n }\n]" Type options: {"rows":5}

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1}

Source§

readonly message?: string

Type options: {"rows":4}

Source§

readonly messageId?: string

The ID of the message

Source§

readonly name?: string

The name of the channel

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "send"
    | "deleteMessage"
    | "react"
    | "sendAndWait"
    | "deleteChannel"
    | "roleAdd"
    | "roleRemove"
    | "sendLegacy"

Default: "send"

Source§

readonly options?:
    | { simplify?: boolean }
    | {
        flags?: (
            "SUPPRESS_EMBEDS"
            | "SUPPRESS_NOTIFICATIONS"
        )[];
        message_reference?: string;
        tts?: boolean;
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
    }
    | {
        appendAttribution?: boolean;
        limitWaitTime?: {
            values: {
                limitType?: | "afterTimeInterval"
                | "atSpecifiedTime";
                maxDateAndTime?: string;
                resumeAmount?: number;
                resumeUnit?: "minutes"
                | "hours"
                | "days";
            };
        };
        messageButtonLabel?: string;
        responseFormButtonLabel?: string;
        responseFormCustomCss?: string;
        responseFormDescription?: string;
        responseFormTitle?: string;
    }
    | {
        bitrate?: number;
        categoryId?: {
            mode: "id"
            | "list"
            | "url";
            value: string;
        };
        nsfw?: boolean;
        position?: number;
        rate_limit_per_user?: number;
        topic?: string;
        user_limit?: number;
    }
    | { filter?: (0 | 2 | 4)[] }
    | {
        avatar_url?: string;
        flags?: ("SUPPRESS_EMBEDS" | "SUPPRESS_NOTIFICATIONS")[];
        tts?: boolean;
        username?: string;
        wait?: boolean;
    }

Default: {}

Source§

readonly resource?: "message" | "member" | "channel"

Default: "channel"

Source§

readonly responseType?: "approval" | "freeText" | "customForm"

Default: "approval"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly role?: unknown[]

Select the roles you want to add to the user Default: [] Type options: {"loadOptionsMethod":"getRoles","loadOptionsDependsOn":["userId.value","guildId.value","operation"]}

Source§

readonly sendTo?: "user" | "channel"

Send message to a channel or DM to a user Default: "channel"

Source§

readonly type?: "2" | "4" | "0"

The type of channel to create Default: "0"

Source§

readonly userId?: { mode: "id" | "list"; value: string }

Select the user you want to assign a role to Default: {"mode":"list","value":""}