Class GradioBot

Hierarchy

  • SlashCommandBuilder
    • GradioBot

Constructors

constructor

Properties

bot commands default_member_permissions default_permission description description_localizations? dm_permission gr name name_localizations? nsfw options

Methods

addAttachmentOption addBooleanOption addChannelOption addIntegerOption addMentionableOption addNumberOption addRoleOption addStringOption addSubcommand addSubcommandGroup addUserOption handle parse register setDMPermission setDefaultMemberPermissions setDefaultPermission setDescription setDescriptionLocalization setDescriptionLocalizations setNSFW setName setNameLocalization setNameLocalizations start toJSON from

Constructors

constructor

Properties

Readonlybot

bot: undefined | Client<boolean>

Readonlycommands

commands: CommandsAdapter

Readonlydefault_member_permissions

default_member_permissions: undefined | null | string

The set of permissions represented as a bit set for the command.

Readonlydefault_permission

default_permission: undefined | boolean

Whether this command is enabled by default when the application is added to a guild.

Deprecated

Use SharedSlashCommand.setDefaultMemberPermissions or SharedSlashCommand.setDMPermission instead.

Readonlydescription

description: string

The description of this command.

Optional Readonlydescription_localizations

description_localizations?: Partial<Record<
    | "id"
    | "en-US"
    | "en-GB"
    | "bg"
    | "zh-CN"
    | "zh-TW"
    | "hr"
    | "cs"
    | "da"
    | "nl"
    | "fi"
    | "fr"
    | "de"
    | "el"
    | "hi"
    | "hu"
    | "it"
    | "ja"
    | "ko"
    | "lt"
    | "no"
    | "pl"
    | "pt-BR"
    | "ro"
    | "ru"
    | "es-ES"
    | "es-419"
    | "sv-SE"
    | "th"
    | "tr"
    | "uk"
    | "vi", null | string>>

The description localizations of this command.

Readonlydm_permission

dm_permission: undefined | boolean

Indicates whether the command is available in direct messages with the application.

Remarks

By default, commands are visible. This property is only for global commands.

Readonlygr

gr: Client

Readonlyname

name: string

The name of this command.

Optional Readonlyname_localizations

name_localizations?: Partial<Record<
    | "id"
    | "en-US"
    | "en-GB"
    | "bg"
    | "zh-CN"
    | "zh-TW"
    | "hr"
    | "cs"
    | "da"
    | "nl"
    | "fi"
    | "fr"
    | "de"
    | "el"
    | "hi"
    | "hu"
    | "it"
    | "ja"
    | "ko"
    | "lt"
    | "no"
    | "pl"
    | "pt-BR"
    | "ro"
    | "ru"
    | "es-ES"
    | "es-419"
    | "sv-SE"
    | "th"
    | "tr"
    | "uk"
    | "vi", null | string>>

The name localizations of this command.

Readonlynsfw

nsfw: undefined | boolean

Whether this command is NSFW.

Readonlyoptions

options: ToAPIApplicationCommandOptions[]

The options of this command.

Methods

addAttachmentOption

  • addAttachmentOption(input): SlashCommandOptionsOnlyBuilder

  • Adds an attachment option.

    Parameters

    • input: SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addBooleanOption

  • addBooleanOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a boolean option.

    Parameters

    • input: SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addChannelOption

  • addChannelOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a channel option.

    Parameters

    • input: SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addIntegerOption

  • addIntegerOption(input): SlashCommandOptionsOnlyBuilder

  • Adds an integer option.

    Parameters

    • input: SlashCommandIntegerOption | ((builder: SlashCommandIntegerOption) => SlashCommandIntegerOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addMentionableOption

  • addMentionableOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a mentionable option.

    Parameters

    • input: SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addNumberOption

  • addNumberOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a number option.

    Parameters

    • input: SlashCommandNumberOption | ((builder: SlashCommandNumberOption) => SlashCommandNumberOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addRoleOption

  • addRoleOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a role option.

    Parameters

    • input: SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addStringOption

  • addStringOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a string option.

    Parameters

    • input: SlashCommandStringOption | ((builder: SlashCommandStringOption) => SlashCommandStringOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

addSubcommand

  • addSubcommand(input): SlashCommandSubcommandsOnlyBuilder

  • Adds a new subcommand to this command.

    Parameters

    • input: SlashCommandSubcommandBuilder | ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder)

      A function that returns a subcommand builder or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

addSubcommandGroup

  • addSubcommandGroup(input): SlashCommandSubcommandsOnlyBuilder

  • Adds a new subcommand group to this command.

    Parameters

    • input: SlashCommandSubcommandGroupBuilder | ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder)

      A function that returns a subcommand group builder or an already built builder

    Returns SlashCommandSubcommandsOnlyBuilder

addUserOption

  • addUserOption(input): SlashCommandOptionsOnlyBuilder

  • Adds a user option.

    Parameters

    • input: SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)

      A function that returns an option builder or an already built builder

    Returns SlashCommandOptionsOnlyBuilder

handle

  • handle(interaction): Promise<boolean>

  • Handles and responds to the given ChatInputCommandInteraction.

    Parameters

    • interaction: ChatInputCommandInteraction<CacheType>

      The ChatInputCommandInteraction.

    Returns Promise<boolean>

    A boolean indicating whether the interaction was handled by this function.

parse

  • parse(interaction): {
        data: Record<string, unknown> | unknown[];
        route: string;
    }

  • Parses the given ChatInputCommandInteraction.

    Parameters

    • interaction: ChatInputCommandInteraction<CacheType>

      The ChatInputCommandInteraction to parse.

    Returns {
        data: Record<string, unknown> | unknown[];
        route: string;
    }

    The route and payload to send to the Gradio endpoint.

    • data: Record<string, unknown> | unknown[]
    • route: string

register

  • register(id?, token?): Promise<void>

  • Parameters

    • id: undefined | string = process.env.BOT_ID
    • token: undefined | string = process.env.BOT_TOKEN

    Returns Promise<void>

setDMPermission

  • setDMPermission(enabled): this

  • Sets if the command is available in direct messages with the application.

    Parameters

    • enabled: undefined | null | boolean

      Whether the command should be enabled in direct messages

    Returns this

    Remarks

    By default, commands are visible. This method is only for global commands.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

setDefaultMemberPermissions

  • setDefaultMemberPermissions(permissions): this

  • Sets the default permissions a member should have in order to run the command.

    Parameters

    • permissions:
          | undefined
          | null
          | string
          | number
          | bigint

      The permissions bit field to set

    Returns this

    Remarks

    You can set this to '0' to disable the command by default.

    See

    https://discord.com/developers/docs/interactions/application-commands#permissions

setDefaultPermission

setDescription

  • setDescription(description): this

  • Sets the description of this command.

    Parameters

    • description: string

      The description to use

    Returns this

setDescriptionLocalization

  • setDescriptionLocalization(locale, localizedDescription): this

  • Sets a description localization for this command.

    Parameters

    • locale:
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi"

      The locale to set

    • localizedDescription: null | string

      The localized description for the given locale

    Returns this

setDescriptionLocalizations

  • setDescriptionLocalizations(localizedDescriptions): this

  • Sets the description localizations for this command.

    Parameters

    • localizedDescriptions: null | Partial<Record<
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi", null | string>>

      The object of localized descriptions to set

    Returns this

setNSFW

  • setNSFW(nsfw?): this

  • Sets whether this command is NSFW.

    Parameters

    • Optionalnsfw: boolean

      Whether this command is NSFW

    Returns this

setName

  • setName(name): this

  • Sets the name of this command.

    Parameters

    • name: string

      The name to use

    Returns this

setNameLocalization

  • setNameLocalization(locale, localizedName): this

  • Sets a name localization for this command.

    Parameters

    • locale:
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi"

      The locale to set

    • localizedName: null | string

      The localized name for the given locale

    Returns this

setNameLocalizations

  • setNameLocalizations(localizedNames): this

  • Sets the name localizations for this command.

    Parameters

    • localizedNames: null | Partial<Record<
          | "id"
          | "en-US"
          | "en-GB"
          | "bg"
          | "zh-CN"
          | "zh-TW"
          | "hr"
          | "cs"
          | "da"
          | "nl"
          | "fi"
          | "fr"
          | "de"
          | "el"
          | "hi"
          | "hu"
          | "it"
          | "ja"
          | "ko"
          | "lt"
          | "no"
          | "pl"
          | "pt-BR"
          | "ro"
          | "ru"
          | "es-ES"
          | "es-419"
          | "sv-SE"
          | "th"
          | "tr"
          | "uk"
          | "vi", null | string>>

      The object of localized names to set

    Returns this

start

toJSON

  • toJSON(): RESTPostAPIChatInputApplicationCommandsJSONBody

  • Serializes this builder to API-compatible JSON data.

    Returns RESTPostAPIChatInputApplicationCommandsJSONBody

    Remarks

    This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.

Staticfrom

  • from(gr, bot?, options?): Promise<GradioBot>

  • Creates a new instance of GradioBot from a Gradio Client instance, Hugging Face Space, or a Gradio server URL.

    Parameters

    • gr: string | Client

      The Gradio Client instance, Hugging Face Spaces, or the Gradio server URL.

    • Optionalbot: Client<boolean>

      The Discord Client instance used to register and respond to commands.

    • Optionaloptions: AdaptOptions

      The options for adapting the Gradio API.

    Returns Promise<GradioBot>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
""