discord.js | AllowedMentionsBuilder

Search...

AllowedMentionsBuilder

export declare class AllowedMentionsBuilder implements JSONEncodable<APIAllowedMentions>

export declare class AllowedMentionsBuilder implements JSONEncodable<APIAllowedMentions>

A builder that creates API-compatible JSON data for allowed mentions.

Implements

JSONEncodable<APIAllowedMentions>

constructor(data?)

Creates a new allowed mentions builder from API data.

Name	Type	Optional	Description
data	Partial<APIAllowedMentions>	Yes	The API data to create this allowed mentions builder with

addRoles(...roles):this

Adds roles to mention.

Name	Type	Optional	Description
...roles	RestOrArray<Snowflake>	No	The roles to mention

addUsers(...users):this

Adds users to mention.

Name	Type	Optional	Description
...users	RestOrArray<Snowflake>	No	The users to mention

clearParse():this

Clears the parse mention types.

clearRoles():this

Clears the roles to mention.

clearUsers():this

Clears the users to mention.

setParse(...parse):this

Sets the types of mentions to parse from the content.

Name	Type	Optional	Description
...parse	RestOrArray<AllowedMentionsTypes>	No	The types of mentions to parse from the content

setRepliedUser(repliedUser?):this

For replies, sets whether to mention the author of the message being replied to.

Name	Type	Optional	Description
repliedUser	boolean	Yes	Whether to mention the author of the message being replied to

setRoles(...roles):this

Sets the roles to mention.

Name	Type	Optional	Description
...roles	RestOrArray<Snowflake>	No	The roles to mention

setUsers(...users):this

Sets the users to mention.

Name	Type	Optional	Description
...users	RestOrArray<Snowflake>	No	The users to mention

spliceRoles(index, deleteCount, ...roles):this

Removes, replaces, or inserts roles.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing roles.

Example

Remove the first role:

allowedMentions.spliceRoles(0, 1);

allowedMentions.spliceRoles(0, 1);

Example

Remove the first n roles:

const n = 4;
allowedMentions.spliceRoles(0, n);

const n = 4;
allowedMentions.spliceRoles(0, n);

Example

Remove the last role:

allowedMentions.spliceRoles(-1, 1);

allowedMentions.spliceRoles(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The number of roles to remove
...roles	RestOrArray<Snowflake>	No	The replacing role ids

spliceUsers(index, deleteCount, ...users):this

Removes, replaces, or inserts users.

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing users.

Example

Remove the first user:

allowedMentions.spliceUsers(0, 1);

allowedMentions.spliceUsers(0, 1);

Example

Remove the first n users:

const n = 4;
allowedMentions.spliceUsers(0, n);

const n = 4;
allowedMentions.spliceUsers(0, n);

Example

Remove the last user:

allowedMentions.spliceUsers(-1, 1);

allowedMentions.spliceUsers(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The number of users to remove
...users	RestOrArray<Snowflake>	No	The replacing user ids

toJSON(validationOverride?):APIAllowedMentions

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference