AllowedMention

Implementation of discords AllowedMention object as a Luau builder.

https://discord.com/developers/docs/resources/message#allowed-mentions-object

Summary

Properties

AllowedMention.parse :: { apiTypes.AllowedMentionTypes }AllowedMention.roles :: { string }AllowedMention.users :: { string }AllowedMention.repliedUser :: boolean?

Methods

AllowedMention:addUserMention(userId: string) → AllowedMentionAllowedMention:addRoleMention(roleId: string) → AllowedMentionAllowedMention:setRepliedUser(repliedUser: boolean) → AllowedMentionAllowedMention:setMentionsEveryone(mentionsEveryone: boolean) → AllowedMentionAllowedMention:build() → JSON

Functions

AllowedMention.new(resource: { roles: { apiTypes.Snowflake }, users: { apiTypes.Snowflake }, repliedUser: boolean?, mentionsEveryone: boolean?, }?) → AllowedMention

Properties

parse

AllowedMention.parse  :: AllowedMentionTypes }

---

An array of allowed mention types to parse from the content.

roles

AllowedMention.roles  :: { string }

---

Array of role_ids to mention (Max size of 100).

users

AllowedMention.users  :: { string }

---

Array of user_ids to mention (Max size of 100).

repliedUser

AllowedMention.repliedUser  :: boolean?

---

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

Methods

addUserMention

AllowedMention : addUserMention ( userId )  -> AllowedMention

Add a user mention to the allowed mentions for this message.

Parameters

userId: string

Returns

AllowedMention

addRoleMention

AllowedMention : addRoleMention ( roleId )  -> AllowedMention

Add a role mention to the allowed mentions for this message.

Parameters

roleId: string

Returns

AllowedMention

setRepliedUser

AllowedMention : setRepliedUser ( repliedUser )  -> AllowedMention

For replies, whether to mention the author of the message being replied to (default false)

Parameters

repliedUser: boolean

Returns

AllowedMention

setMentionsEveryone

AllowedMention : setMentionsEveryone ( mentionsEveryone )  -> AllowedMention

Controls @everyone and @here mentions

Parameters

mentionsEveryone: boolean

Returns

AllowedMention

build

AllowedMention : build ( )  -> JSON

Responsible for building the AllowedMention JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

AllowedMention . new ( resource )  -> AllowedMention

Responsible for creating a new AllowedMention.

Parameters

resource: { { roles: { apiTypes.Snowflake } }

Returns

AllowedMention