Results

Namespace

Type

Options available for outgoing messages.

Note: If an embed is not included, content must be included and greater than 0 characters long.

See discord.Message.IAllowedMentions for more information on the allowedMentions property.

Hierarchy

  • IOutgoingMessageOptions <-- You are here!

Index

Properties

Optional allowedMentions

allowedMentions: IAllowedMentions

If set, will restrict the notifications sent with this message if mention strings are included.

By default (undefined), the message will be allowed to ping all mentioned entities.

It is highly recommended you specify this property when sending messages that include user input.

Setting this property to an empty object (ex: {}) will prevent any messages from being sent. See discord.Message.IAllowedMentions for more details on the possible configurations for this property.

Optional attachments

If set, will attempt to upload entries as file attachments to the message.

Optional content

content: undefined | string

The message's text content.

If the message has no embed, the content must be greater than 0 characters in length.

Optional embed

embed: Embed | null

An optional discord.Embed to include with this message.

If null, the embed will be removed. If removing the embed, you must send the content property.

Optional reply

When this is set, the message will attempt to become an inline reply of the provided message reference.

The message or snowflake set here must reference a message inside the channel being sent to, otherwise an error will be thrown.

You can configure wether the author of the message referenced here gets pinged by setting allowedMentions with repliedMessage set to false.

Setting this on a discord.Message.inlineReply call overrides it. Conversely, setting it to null suppresses it.

Optional tts

tts: undefined | false | true

If true, clients with tts enabled and are focused on the channel will hear the message via text-to-speech.

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