Class MessageController

Controller for message features.

Constructors

constructor

Methods

create get getMany

Constructors

constructor

Methods

create

  • create(channelId, body): Promise<Result<RESTError | Error, APIMessage>>

  • Post a message to a channel.

    Parameters

    • channelId: string

      Channel ID to send message.

    • body: RESTPostAPIChannelMessageJSONBody

      Message contents, embeds, etc.

    Returns Promise<Result<RESTError | Error, APIMessage>>

    Example: Posting a text message.

    const result = await client.message.create("CHANNEL_ID", { content: "Hello, world!" });

get

  • get(channelId, messageId): Promise<Result<RESTError | Error, APIMessage>>

  • Retrieve a message in a channel.

    Parameters

    • channelId: string

      Channel ID to get message.

    • messageId: string

      Message ID to get.

    Returns Promise<Result<RESTError | Error, APIMessage>>

    Example: Retrieving a specific message.

    const result = await client.message.get("CHANNEL_ID", "MESSAGE_ID");

getMany

  • getMany(channelId, option?): Promise<Result<RESTError | Error, RESTGetAPIChannelMessagesResult>>

  • Retrieve the messages in a channel.

    Parameters

    • channelId: string

      Channel ID to get messages.

    • Optionaloption: RESTGetAPIChannelMessagesQuery

      Query options to filter messages.

    Returns Promise<Result<RESTError | Error, RESTGetAPIChannelMessagesResult>>

    Example: Retrieving the last 10 messages in the channel.

    const result = await client.message.getMany("CHANNEL_ID", { limit: 10 });

Settings

Member Visibility

On This Page

Constructors
Methods