DiscordLua
discorddiscord
v1.2.4
Install

WidgetMember

Class
On this page

WidgetMember 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

WidgetMember.activity

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

WidgetMember.avatar

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

WidgetMember.channelId

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

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

WidgetMember.deaf

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

WidgetMember.discriminator

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

WidgetMember.id

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

WidgetMember.mute

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

WidgetMember.raw

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

WidgetMember.selfDeaf

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

WidgetMember.selfMute

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

WidgetMember.status

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

WidgetMember.suppress

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

WidgetMember.username

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

Methods

WidgetMember:avatarURL()

#

Performs avatar url on this WidgetMember. Call it from bot code when you need that operation on the current object.

Signature

WidgetMember:avatarURL(options)

Parameters

NameTypeRequiredBehavior
options table optional Lua option table. Field names match the corresponding DiscordLua option type when one exists.

Returns

WidgetMember — the same instance, for chaining.

Example

lua
local discord = require("discord")
-- object is a WidgetMember
object:avatarURL({})

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