Results

Namespace

Type

A private 1-1 channel between the bot user and another discord.User.

Hierarchy

  • Channel
    • DmChannel <-- You are here!

Implements

Index

Type aliases

Static AnyChannel

Represents any channel type on Discord.

Static AnyGuildChannel

Represents any channel type on Discord that exists within a discord.Guild.

Properties

Readonly id

Discord's unique identifier for this channel. This value never changes.

Readonly type

type: DM

The type of this channel. Always discord.Channel.Type.DM.

Methods

delete

  • delete(): Promise<void>
  • Attempts to delete the channel.

    If an error occurs, a discord.ApiError exception is thrown.

    Returns Promise<void>

getMessage

  • getMessage(messageId: string): Promise<Message | null>
  • Attempts to fetch a single discord.Message (by id) from this channel.

    If no message is found, the Promise resolves as null.

    Parameters

    • messageId: string

      The id of the message you wish to fetch data for.

    Returns Promise<Message | null>

sendMessage

triggerTypingIndicator

  • triggerTypingIndicator(): Promise<void>
  • Triggers the *Username* is typing... message to appear near the text input box for users focused on the channel.

    The typing indicator will last up to 15 seconds, or until the bot user sends a message in the channel. Whatever comes first.

    Typically unused by bots, but can be used to indicate a command response is "loading" or "processing."

    Returns Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc