GuildAuditLogEntry
ClassOn this page
GuildAuditLogEntry is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- Name
action- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.action. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
actionType- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.actionType. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
changes- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.changes. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- 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 GuildAuditLogEntry.
- Name
executor- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.executor. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
executorId- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.executorId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
extra- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.extra. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
guild- Type
any- Access
- readonly
- Description
- Guild this GuildAuditLogEntry belongs to, when the payload included a guild id.
- Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
guildId- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.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 GuildAuditLogEntry.
- Name
id- Type
any- Access
- readonly
- Description
- Snowflake id of this GuildAuditLogEntry.
- Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
options- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.options. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.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 GuildAuditLogEntry.
- Name
reason- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.reason. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
targetId- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.targetId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
- Name
targetType- Type
any- Access
- readonly
- Description
- Instance field
GuildAuditLogEntry.targetType. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this GuildAuditLogEntry.
Methods
Performs action type on this GuildAuditLogEntry. Call it from bot code when you need that operation on the current object.
Signature
GuildAuditLogEntry.actionType(action) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
action |
any |
required | Passed through to the implementation as written. |
Returns
GuildAuditLogEntry — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
GuildAuditLogEntry.actionType(action)GuildAuditLogEntry:createdAt()
#Create dAt through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.
Signature
GuildAuditLogEntry:createdAt() Parameters
No parameters.
Returns
GuildAuditLogEntry — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:createdAt()GuildAuditLogEntry:createdTimestamp()
#Create dTimestamp through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.
Signature
GuildAuditLogEntry:createdTimestamp() Parameters
No parameters.
Returns
GuildAuditLogEntry — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:createdTimestamp()GuildAuditLogEntry:isAction()
#Predicate that returns whether this GuildAuditLogEntry matches isAction. Use it to branch before calling type-specific methods.
Signature
GuildAuditLogEntry:isAction(action) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
action |
any |
required | Passed through to the implementation as written. |
Returns
GuildAuditLogEntry — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:isAction(action)GuildAuditLogEntry:isUpdate()
#Predicate that returns whether this GuildAuditLogEntry matches isUpdate. Use it to branch before calling type-specific methods.
Signature
GuildAuditLogEntry:isUpdate() Parameters
No parameters.
Returns
any.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:isUpdate()GuildAuditLogEntry:target()
#Performs target on this GuildAuditLogEntry. Call it from bot code when you need that operation on the current object.
Signature
GuildAuditLogEntry:target() Parameters
No parameters.
Returns
any.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:target()Performs target type on this GuildAuditLogEntry. Call it from bot code when you need that operation on the current object.
Signature
GuildAuditLogEntry.targetType(action) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
action |
any |
required | Passed through to the implementation as written. |
Returns
any.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
GuildAuditLogEntry.targetType(action)GuildAuditLogEntry:toJSON()
#Serialize this GuildAuditLogEntry into a Lua table suitable for REST or debugging.
Signature
GuildAuditLogEntry:toJSON() Parameters
No parameters.
Returns
any.
Example
local discord = require("discord")
-- object is a GuildAuditLogEntry
object:toJSON()Static members
-
GuildAuditLogEntry.Targets
Examples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment
Version: discord 1.2.4 · runtime 1.0.0