Class Bot

constructor

• new Bot(collection: BotCollection, id: string): Bot

  Construct Bot

  Parameters

  • collection: BotCollection

    Collection
  • id: string

    Id

  Returns Bot

Readonlyid

$exists

• get $exists(): boolean

  Whether this object exists

  Returns boolean

analytics

• get analytics(): boolean

  Whether this bot has analytics enabled

  Returns boolean

createdAt

• get createdAt(): Date

  Time when this user created their account

  Returns Date

discoverable

• get discoverable(): boolean

  Whether this bot shows up on Discover

  Returns boolean

flags

• get flags(): BotFlags

  Bot Flags

  Returns BotFlags

interactionsUrl

• get interactionsUrl(): undefined | string

  Interactions URL

  Returns undefined | string

owner

• get owner(): undefined | User

  Owner

  Returns undefined | User

ownerId

• get ownerId(): string

  Owner's Id

  Returns string

privacyPolicyUrl

• get privacyPolicyUrl(): undefined | string

  Link to privacy policy

  Returns undefined | string

public

• get public(): boolean

  Whether this bot can be invited by anyone

  Returns boolean

publicBot

• get publicBot(): PublicBot

  Instantiate PublicBot class from this bot

  Returns PublicBot

termsOfServiceUrl

• get termsOfServiceUrl(): undefined | string

  Link to terms of service

  Returns undefined | string

token

• get token(): string

  Bot Token

  Returns string

user

• get user(): undefined | User

  Corresponding user

  Returns undefined | User

delete

• delete(): Promise<void>

  Delete a bot

  Returns Promise<void>

edit

• edit(
      data: {
          analytics?: null | boolean;
          interactions_url?: null | string;
          name?: null | string;
          public?: null | boolean;
          remove?: ("Token" | "InteractionsURL")[];
      },
  ): Promise<void>

  Edit a bot

  Parameters

  • data: {
        analytics?: null | boolean;
        interactions_url?: null | string;
        name?: null | string;
        public?: null | boolean;
        remove?: ("Token" | "InteractionsURL")[];
    }

    Changes

    • Optionalanalytics?: null | boolean

      Description

      Whether analytics should be gathered for this bot

      Must be enabled in order to show up on Revolt Discover.

    • Optionalinteractions_url?: null | string

      Description

      Interactions URL

    • Optionalname?: null | string

      Description

      Bot username

    • Optionalpublic?: null | boolean

      Description

      Whether the bot can be added by anyone

    • Optionalremove?: ("Token" | "InteractionsURL")[]

      Description

      Fields to remove from bot object

      Default

      []
      Copy

  Returns Promise<void>

toString

• toString(): string

  Convert to string

  Returns string

  String