Results

Namespace

Type

Allowed mentions lets you fine-tune what mentions are notified in outgoing messages. It is highly recommended you include this option when sending message content containing user input.

Setting this option to {} will block all mentions from notifying their targets.

Hierarchy

  • IAllowedMentions <-- You are here!

Index

Properties

Properties

Optional everyone

everyone: undefined | false | true

If set to true, this message will be allowed to ping at-everyone.

Optional reply

reply: undefined | false | true

If set to true, this message will be allowed to ping the author of the referenced message for inline replies.

If this isn't set, this is inferred to be true.

Optional roles

roles: true | Array<Snowflake | Role>

If set to true, this message will be allowed to ping all role mentions.

You may pass an array of role ids or role objects to whitelist a set of roles you'd like to restrict notifications to.

Optional users

users: true | Array<Snowflake | User | GuildMember>

If set to true, this message will be allowed to ping all users mentioned.

You may pass an array of user ids or user/guildMember objects to whitelist a set of users you'd like to restrict notifications to.

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