DiscordLua
discorddiscord
v1.2.4
Install

ThreadMember

Class
On this page

ThreadMember 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

ThreadMember.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 ThreadMember.

ThreadMember.flags

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

ThreadMember.guildId

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

ThreadMember.id

# readonly
Name
id
Type
any
Access
readonly
Description
Snowflake id of this ThreadMember.
Availability
Populated from the Gateway/REST payload or constructor for this ThreadMember.

ThreadMember.joinedTimestamp

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

ThreadMember.member

# readonly
Name
member
Type
Member
Access
readonly
Description
Guild member view of the user, when the event occurred in a guild.
Availability
Populated from the Gateway/REST payload or constructor for this ThreadMember.
Related
Member

ThreadMember.partial

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

ThreadMember.raw

# readonly
Name
raw
Type
any
Access
readonly
Description
Instance field ThreadMember.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 ThreadMember.

ThreadMember.thread

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

ThreadMember.threadId

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

ThreadMember.user

# readonly
Name
user
Type
any
Access
readonly
Description
User object associated with this ThreadMember.
Availability
Populated from the Gateway/REST payload or constructor for this ThreadMember.

ThreadMember.userId

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

Methods

ThreadMember:guildMember()

#

Performs guild member on this ThreadMember. Call it from bot code when you need that operation on the current object.

Signature

ThreadMember:guildMember()

Parameters

No parameters.

Returns

ThreadMember — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a ThreadMember
object:guildMember()

ThreadMember:joinedAt()

#

Performs joined at on this ThreadMember. Call it from bot code when you need that operation on the current object.

Signature

ThreadMember:joinedAt()

Parameters

No parameters.

Returns

ThreadMember — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a ThreadMember
object:joinedAt()

ThreadMember:manageable()

#

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

Signature

ThreadMember:manageable()

Parameters

No parameters.

Returns

ThreadMember — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a ThreadMember
object:manageable()

ThreadMember:remove()

#

Remove an item from this ThreadMember.

Signature

ThreadMember:remove()

Parameters

No parameters.

Returns

ThreadMember — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a ThreadMember
object:remove()

ThreadMember:toJSON()

#

Serialize this ThreadMember into a Lua table suitable for REST or debugging.

Signature

ThreadMember:toJSON()

Parameters

No parameters.

Returns

any.

Example

lua
local discord = require("discord")
-- object is a ThreadMember
object:toJSON()

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