DiscordLua
discorddiscord
v1.2.4
Install

MessageMentions

Class
On this page

MessageMentions is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

class Module 1.2.4 Source

Properties

MessageMentions.channels

# readonly
Name
channels
Type
Collection
Access
readonly
Description
Instance field MessageMentions.channels. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

MessageMentions.client

# readonly
Name
client
Type
any
Access
readonly
Description
Owning Client instance used for REST, cache, and event dispatch.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.

MessageMentions.crosspostedChannels

# readonly
Name
crosspostedChannels
Type
Collection
Access
readonly
Description
Instance field MessageMentions.crosspostedChannels. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

MessageMentions.everyone

# readonly
Name
everyone
Type
any
Access
readonly
Description
Instance field MessageMentions.everyone. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.

MessageMentions.members

# readonly
Name
members
Type
Collection
Access
readonly
Description
Instance field MessageMentions.members. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

MessageMentions.parsedUsers

# readonly
Name
parsedUsers
Type
Collection
Access
readonly
Description
Instance field MessageMentions.parsedUsers. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

MessageMentions.raw

# readonly
Name
raw
Type
any
Access
readonly
Description
Instance field MessageMentions.raw. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.

MessageMentions.repliedUser

# readonly
Name
repliedUser
Type
User
Access
readonly
Description
Instance field MessageMentions.repliedUser. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
User

MessageMentions.roles

# readonly
Name
roles
Type
Collection
Access
readonly
Description
Instance field MessageMentions.roles. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

MessageMentions.users

# readonly
Name
users
Type
Collection
Access
readonly
Description
Instance field MessageMentions.users. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability
Populated from the Gateway/REST payload or constructor for this MessageMentions.
Related
Collection

Methods

MessageMentions:has()

#

Performs has on this MessageMentions. Call it from bot code when you need that operation on the current object.

Signature

MessageMentions:has(id)

Parameters

NameTypeRequiredBehavior
id string required Snowflake id string.

Returns

MessageMentions — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a MessageMentions
object:has("123")

Static members

  • MessageMentions.ChannelsPattern
  • MessageMentions.EveryonePattern
  • MessageMentions.RolesPattern
  • MessageMentions.UsersPattern

Examples

Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.

ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment

Version: discord 1.2.4 · runtime 1.0.0

Search Ctrl K Navigate Open Esc