Types
TypeNamed option tables exported on discord (for example discord.MessageCreateOptions). Pass a Lua table with these keys to create, edit, and fetch helpers. encode maps camelCase fields to the REST body.
BaseFetchOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
BaseMessageOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
tts | Tts field consumed when encoding this options table. |
nonce | Nonce field consumed when encoding this options table. |
stickers | Stickers field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
BaseMessageOptionsWithPoll
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
BaseMessageCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
tts | Tts field consumed when encoding this options table. |
nonce | Nonce field consumed when encoding this options table. |
enforceNonce | Enforce Nonce field consumed when encoding this options table. |
stickers | Stickers field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
messageReference | Message Reference field consumed when encoding this options table. |
sharedClientTheme | Shared Client Theme field consumed when encoding this options table. |
MessageCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
tts | Tts field consumed when encoding this options table. |
nonce | Nonce field consumed when encoding this options table. |
enforceNonce | Enforce Nonce field consumed when encoding this options table. |
stickers | Stickers field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
reply | Reply field consumed when encoding this options table. |
messageReference | Message Reference field consumed when encoding this options table. |
failIfNotExists | Fail If Not Exists field consumed when encoding this options table. |
sharedClientTheme | Shared Client Theme field consumed when encoding this options table. |
MessageEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
attachments | Attachments field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
MessageReplyOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
failIfNotExists | Fail If Not Exists field consumed when encoding this options table. |
ReplyOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
messageReference | Message Reference field consumed when encoding this options table. |
failIfNotExists | Fail If Not Exists field consumed when encoding this options table. |
ForwardOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
message | Message field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
FetchMessageOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
FetchMessagesOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
limit | Limit field consumed when encoding this options table. |
before | Before field consumed when encoding this options table. |
after | After field consumed when encoding this options table. |
around | Around field consumed when encoding this options table. |
cache | Cache field consumed when encoding this options table. |
FetchPinnedMessagesOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
before | Before field consumed when encoding this options table. |
limit | Limit field consumed when encoding this options table. |
InteractionReplyOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
tts | Tts field consumed when encoding this options table. |
ephemeral | Ephemeral field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
fetchReply | Fetch Reply field consumed when encoding this options table. |
InteractionEditReplyOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
attachments | Attachments field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
InteractionDeferReplyOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
ephemeral | Ephemeral field consumed when encoding this options table. |
fetchReply | Fetch Reply field consumed when encoding this options table. |
InteractionDeferUpdateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
fetchReply | Fetch Reply field consumed when encoding this options table. |
InteractionUpdateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
LaunchActivityOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
title | Title field consumed when encoding this options table. |
ShowModalOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
customId | Custom Id field consumed when encoding this options table. |
title | Title field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
InviteCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
maxAge | Max Age field consumed when encoding this options table. |
maxUses | Max Uses field consumed when encoding this options table. |
temporary | Temporary field consumed when encoding this options table. |
unique | Unique field consumed when encoding this options table. |
targetType | Target Type field consumed when encoding this options table. |
targetUser | Target User field consumed when encoding this options table. |
targetApplication | Target Application field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
guest | Guest field consumed when encoding this options table. |
isGuestInvite | Is Guest Invite field consumed when encoding this options table. |
FetchInviteOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
withCounts | With Counts field consumed when encoding this options table. |
withExpiration | With Expiration field consumed when encoding this options table. |
guildScheduledEvent | Guild Scheduled Event field consumed when encoding this options table. |
ClientFetchInviteOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
withCounts | With Counts field consumed when encoding this options table. |
withExpiration | With Expiration field consumed when encoding this options table. |
guildScheduledEvent | Guild Scheduled Event field consumed when encoding this options table. |
FetchInvitesOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
GuildCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
icon | Icon field consumed when encoding this options table. |
channels | Channels field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
afkChannelId | Afk Channel Id field consumed when encoding this options table. |
afkTimeout | Afk Timeout field consumed when encoding this options table. |
systemChannelId | System Channel Id field consumed when encoding this options table. |
systemChannelFlags | System Channel Flags field consumed when encoding this options table. |
GuildEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
icon | Icon field consumed when encoding this options table. |
splash | Splash field consumed when encoding this options table. |
discoverySplash | Discovery Splash field consumed when encoding this options table. |
banner | Banner field consumed when encoding this options table. |
afkChannel | Afk Channel field consumed when encoding this options table. |
afkTimeout | Afk Timeout field consumed when encoding this options table. |
systemChannel | System Channel field consumed when encoding this options table. |
systemChannelFlags | System Channel Flags field consumed when encoding this options table. |
rulesChannel | Rules Channel field consumed when encoding this options table. |
publicUpdatesChannel | Public Updates Channel field consumed when encoding this options table. |
preferredLocale | Preferred Locale field consumed when encoding this options table. |
features | Features field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
premiumProgressBarEnabled | Premium Progress Bar Enabled field consumed when encoding this options table. |
safetyAlertsChannel | Safety Alerts Channel field consumed when encoding this options table. |
verificationLevel | Verification Level field consumed when encoding this options table. |
explicitContentFilter | Explicit Content Filter field consumed when encoding this options table. |
defaultMessageNotifications | Default Message Notifications field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
FetchGuildOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
withCounts | With Counts field consumed when encoding this options table. |
FetchGuildsOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
before | Before field consumed when encoding this options table. |
after | After field consumed when encoding this options table. |
limit | Limit field consumed when encoding this options table. |
GuildChannelCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
topic | Topic field consumed when encoding this options table. |
bitrate | Bitrate field consumed when encoding this options table. |
userLimit | User Limit field consumed when encoding this options table. |
parent | Parent field consumed when encoding this options table. |
parentId | Parent Id field consumed when encoding this options table. |
nsfw | Nsfw field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
position | Position field consumed when encoding this options table. |
permissionOverwrites | Permission Overwrites field consumed when encoding this options table. |
rtcRegion | Rtc Region field consumed when encoding this options table. |
videoQualityMode | Video Quality Mode field consumed when encoding this options table. |
defaultAutoArchiveDuration | Default Auto Archive Duration field consumed when encoding this options table. |
availableTags | Available Tags field consumed when encoding this options table. |
defaultReactionEmoji | Default Reaction Emoji field consumed when encoding this options table. |
defaultSortOrder | Default Sort Order field consumed when encoding this options table. |
defaultForumLayout | Default Forum Layout field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildChannelEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
topic | Topic field consumed when encoding this options table. |
bitrate | Bitrate field consumed when encoding this options table. |
userLimit | User Limit field consumed when encoding this options table. |
parent | Parent field consumed when encoding this options table. |
parentId | Parent Id field consumed when encoding this options table. |
nsfw | Nsfw field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
position | Position field consumed when encoding this options table. |
permissionOverwrites | Permission Overwrites field consumed when encoding this options table. |
rtcRegion | Rtc Region field consumed when encoding this options table. |
videoQualityMode | Video Quality Mode field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
CategoryCreateChannelOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
topic | Topic field consumed when encoding this options table. |
bitrate | Bitrate field consumed when encoding this options table. |
userLimit | User Limit field consumed when encoding this options table. |
nsfw | Nsfw field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
position | Position field consumed when encoding this options table. |
permissionOverwrites | Permission Overwrites field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
CreateChannelOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
parent | Parent field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildChannelCloneOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
SetParentOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
lockPermissions | Lock Permissions field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
FetchChannelOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
allowUnknownGuild | Allow Unknown Guild field consumed when encoding this options table. |
RoleCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
color | Color field consumed when encoding this options table. |
colors | Colors field consumed when encoding this options table. |
hoist | Hoist field consumed when encoding this options table. |
mentionable | Mentionable field consumed when encoding this options table. |
permissions | Permissions field consumed when encoding this options table. |
icon | Icon field consumed when encoding this options table. |
unicodeEmoji | Unicode Emoji field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
position | Position field consumed when encoding this options table. |
RoleEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
color | Color field consumed when encoding this options table. |
colors | Colors field consumed when encoding this options table. |
hoist | Hoist field consumed when encoding this options table. |
mentionable | Mentionable field consumed when encoding this options table. |
permissions | Permissions field consumed when encoding this options table. |
icon | Icon field consumed when encoding this options table. |
unicodeEmoji | Unicode Emoji field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
BanOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
deleteMessageSeconds | Delete Message Seconds field consumed when encoding this options table. |
deleteMessageDays | Delete Message Days field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
BulkBanOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
deleteMessageSeconds | Delete Message Seconds field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
FetchBanOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
FetchBansOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
limit | Limit field consumed when encoding this options table. |
before | Before field consumed when encoding this options table. |
after | After field consumed when encoding this options table. |
GuildMemberEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
nick | Nick field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
mute | Mute field consumed when encoding this options table. |
deaf | Deaf field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
communicationDisabledUntil | Communication Disabled Until field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
AddGuildMemberOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
accessToken | Access Token field consumed when encoding this options table. |
nick | Nick field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
mute | Mute field consumed when encoding this options table. |
deaf | Deaf field consumed when encoding this options table. |
FetchMemberOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
FetchMembersOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
query | Query field consumed when encoding this options table. |
limit | Limit field consumed when encoding this options table. |
withPresences | With Presences field consumed when encoding this options table. |
user | User field consumed when encoding this options table. |
nonce | Nonce field consumed when encoding this options table. |
time | Time field consumed when encoding this options table. |
GuildListMembersOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
limit | Limit field consumed when encoding this options table. |
after | After field consumed when encoding this options table. |
GuildSearchMembersOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
query | Query field consumed when encoding this options table. |
limit | Limit field consumed when encoding this options table. |
GuildPruneMembersOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
days | Days field consumed when encoding this options table. |
dry | Dry field consumed when encoding this options table. |
count | Count field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
WebhookCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
avatar | Avatar field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
WebhookEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
avatar | Avatar field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
WebhookDeleteOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
reason | Reason field consumed when encoding this options table. |
WebhookMessageCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
threadId | Thread Id field consumed when encoding this options table. |
username | Username field consumed when encoding this options table. |
avatarURL | Avatar URL field consumed when encoding this options table. |
tts | Tts field consumed when encoding this options table. |
poll | Poll field consumed when encoding this options table. |
WebhookMessageEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
attachments | Attachments field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
threadId | Thread Id field consumed when encoding this options table. |
ChannelWebhookCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
avatar | Avatar field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
WebhookFetchMessageOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
threadId | Thread Id field consumed when encoding this options table. |
cache | Cache field consumed when encoding this options table. |
AutoModerationRuleCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
eventType | Event Type field consumed when encoding this options table. |
triggerType | Trigger Type field consumed when encoding this options table. |
triggerMetadata | Trigger Metadata field consumed when encoding this options table. |
actions | Actions field consumed when encoding this options table. |
enabled | Enabled field consumed when encoding this options table. |
exemptRoles | Exempt Roles field consumed when encoding this options table. |
exemptChannels | Exempt Channels field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
AutoModerationRuleEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
eventType | Event Type field consumed when encoding this options table. |
triggerMetadata | Trigger Metadata field consumed when encoding this options table. |
actions | Actions field consumed when encoding this options table. |
enabled | Enabled field consumed when encoding this options table. |
exemptRoles | Exempt Roles field consumed when encoding this options table. |
exemptChannels | Exempt Channels field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
FetchAutoModerationRuleOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
FetchAutoModerationRulesOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
GuildScheduledEventCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
scheduledStartTime | Scheduled Start Time field consumed when encoding this options table. |
scheduledEndTime | Scheduled End Time field consumed when encoding this options table. |
privacyLevel | Privacy Level field consumed when encoding this options table. |
entityType | Entity Type field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
entityMetadata | Entity Metadata field consumed when encoding this options table. |
image | Image field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
recurrenceRule | Recurrence Rule field consumed when encoding this options table. |
GuildScheduledEventEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
scheduledStartTime | Scheduled Start Time field consumed when encoding this options table. |
scheduledEndTime | Scheduled End Time field consumed when encoding this options table. |
privacyLevel | Privacy Level field consumed when encoding this options table. |
entityType | Entity Type field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
status | Status field consumed when encoding this options table. |
entityMetadata | Entity Metadata field consumed when encoding this options table. |
image | Image field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
FetchGuildScheduledEventOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
withUserCount | With User Count field consumed when encoding this options table. |
FetchGuildScheduledEventsOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
withUserCount | With User Count field consumed when encoding this options table. |
StageInstanceCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
channel | Channel field consumed when encoding this options table. |
topic | Topic field consumed when encoding this options table. |
privacyLevel | Privacy Level field consumed when encoding this options table. |
sendStartNotification | Send Start Notification field consumed when encoding this options table. |
guildScheduledEvent | Guild Scheduled Event field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
StageInstanceEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
topic | Topic field consumed when encoding this options table. |
privacyLevel | Privacy Level field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildEmojiCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
attachment | Attachment field consumed when encoding this options table. |
name | Name field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildEmojiEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
roles | Roles field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
ApplicationEmojiCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
attachment | Attachment field consumed when encoding this options table. |
name | Name field consumed when encoding this options table. |
ApplicationEmojiEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
GuildStickerCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
file | File field consumed when encoding this options table. |
name | Name field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
tags | Tags field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildStickerEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
tags | Tags field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
StartThreadOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
autoArchiveDuration | Auto Archive Duration field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
ThreadEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
archived | Archived field consumed when encoding this options table. |
autoArchiveDuration | Auto Archive Duration field consumed when encoding this options table. |
locked | Locked field consumed when encoding this options table. |
invitable | Invitable field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
appliedTags | Applied Tags field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildForumThreadCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
autoArchiveDuration | Auto Archive Duration field consumed when encoding this options table. |
message | Message field consumed when encoding this options table. |
appliedTags | Applied Tags field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildTextThreadCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
autoArchiveDuration | Auto Archive Duration field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
rateLimitPerUser | Rate Limit Per User field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
invitable | Invitable field consumed when encoding this options table. |
GuildForumThreadMessageCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
content | Content field consumed when encoding this options table. |
embeds | Embeds field consumed when encoding this options table. |
files | Files field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
allowedMentions | Allowed Mentions field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
stickers | Stickers field consumed when encoding this options table. |
VoiceStateEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
channel | Channel field consumed when encoding this options table. |
suppress | Suppress field consumed when encoding this options table. |
requestToSpeak | Request To Speak field consumed when encoding this options table. |
ClientUserEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
username | Username field consumed when encoding this options table. |
avatar | Avatar field consumed when encoding this options table. |
banner | Banner field consumed when encoding this options table. |
ClientApplicationEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
customInstallUrl | Custom Install Url field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
roleConnectionsVerificationUrl | Role Connections Verification Url field consumed when encoding this options table. |
installParams | Install Params field consumed when encoding this options table. |
flags | Flags field consumed when encoding this options table. |
icon | Icon field consumed when encoding this options table. |
coverImage | Cover Image field consumed when encoding this options table. |
interactionsEndpointUrl | Interactions Endpoint Url field consumed when encoding this options table. |
tags | Tags field consumed when encoding this options table. |
IncidentActionsEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
invitesDisabledUntil | Invites Disabled Until field consumed when encoding this options table. |
dmsDisabledUntil | Dms Disabled Until field consumed when encoding this options table. |
PresenceData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
status | Status field consumed when encoding this options table. |
afk | Afk field consumed when encoding this options table. |
activities | Activities field consumed when encoding this options table. |
shardId | Shard Id field consumed when encoding this options table. |
ActivityOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
url | Url field consumed when encoding this options table. |
state | State field consumed when encoding this options table. |
ActivitiesOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
type | Type field consumed when encoding this options table. |
url | Url field consumed when encoding this options table. |
state | State field consumed when encoding this options table. |
ApplicationCommandPermissionsEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
permissions | Permissions field consumed when encoding this options table. |
token | Token field consumed when encoding this options table. |
EntitlementCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
sku | Sku field consumed when encoding this options table. |
user | User field consumed when encoding this options table. |
guild | Guild field consumed when encoding this options table. |
owner | Owner field consumed when encoding this options table. |
FetchEntitlementOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
cache | Cache field consumed when encoding this options table. |
force | Force field consumed when encoding this options table. |
FetchEntitlementsOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
limit | Limit field consumed when encoding this options table. |
guild | Guild field consumed when encoding this options table. |
user | User field consumed when encoding this options table. |
skus | Skus field consumed when encoding this options table. |
excludeEnded | Exclude Ended field consumed when encoding this options table. |
excludeDeleted | Exclude Deleted field consumed when encoding this options table. |
GuildSoundboardSoundCreateOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
sound | Sound field consumed when encoding this options table. |
volume | Volume field consumed when encoding this options table. |
emojiId | Emoji Id field consumed when encoding this options table. |
emojiName | Emoji Name field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
GuildSoundboardSoundEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
volume | Volume field consumed when encoding this options table. |
emojiId | Emoji Id field consumed when encoding this options table. |
emojiName | Emoji Name field consumed when encoding this options table. |
reason | Reason field consumed when encoding this options table. |
CollectorOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
filter | Filter field consumed when encoding this options table. |
time | Time field consumed when encoding this options table. |
idle | Idle field consumed when encoding this options table. |
max | Max field consumed when encoding this options table. |
dispose | Dispose field consumed when encoding this options table. |
InteractionCollectorOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
filter | Filter field consumed when encoding this options table. |
time | Time field consumed when encoding this options table. |
idle | Idle field consumed when encoding this options table. |
max | Max field consumed when encoding this options table. |
maxComponents | Max Components field consumed when encoding this options table. |
maxUsers | Max Users field consumed when encoding this options table. |
message | Message field consumed when encoding this options table. |
channel | Channel field consumed when encoding this options table. |
guild | Guild field consumed when encoding this options table. |
interactionType | Interaction Type field consumed when encoding this options table. |
componentType | Component Type field consumed when encoding this options table. |
MessageCollectorOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
filter | Filter field consumed when encoding this options table. |
time | Time field consumed when encoding this options table. |
idle | Idle field consumed when encoding this options table. |
max | Max field consumed when encoding this options table. |
maxProcessed | Max Processed field consumed when encoding this options table. |
ReactionCollectorOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
filter | Filter field consumed when encoding this options table. |
time | Time field consumed when encoding this options table. |
idle | Idle field consumed when encoding this options table. |
max | Max field consumed when encoding this options table. |
maxEmojis | Max Emojis field consumed when encoding this options table. |
maxUsers | Max Users field consumed when encoding this options table. |
WelcomeScreenEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
enabled | Enabled field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
welcomeChannels | Welcome Channels field consumed when encoding this options table. |
GuildOnboardingEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
prompts | Prompts field consumed when encoding this options table. |
defaultChannels | Default Channels field consumed when encoding this options table. |
enabled | Enabled field consumed when encoding this options table. |
mode | Mode field consumed when encoding this options table. |
GuildTemplateEditOptions
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
name | Name field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
FileUploadModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
values | Values field consumed when encoding this options table. |
RadioGroupModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
values | Values field consumed when encoding this options table. |
CheckboxGroupModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
values | Values field consumed when encoding this options table. |
CheckboxModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
value | Value field consumed when encoding this options table. |
LabelModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
label | Label field consumed when encoding this options table. |
component | Component field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
LabelData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
label | Label field consumed when encoding this options table. |
component | Component field consumed when encoding this options table. |
description | Description field consumed when encoding this options table. |
FileUploadComponentData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
minValues | Min Values field consumed when encoding this options table. |
maxValues | Max Values field consumed when encoding this options table. |
required | Required field consumed when encoding this options table. |
RadioGroupComponentData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
required | Required field consumed when encoding this options table. |
options | Options field consumed when encoding this options table. |
CheckboxGroupComponentData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
minValues | Min Values field consumed when encoding this options table. |
maxValues | Max Values field consumed when encoding this options table. |
required | Required field consumed when encoding this options table. |
options | Options field consumed when encoding this options table. |
CheckboxComponentData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
value | Value field consumed when encoding this options table. |
required | Required field consumed when encoding this options table. |
TextInputModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
value | Value field consumed when encoding this options table. |
SelectMenuModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
customId | Custom Id field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
values | Values field consumed when encoding this options table. |
TextDisplayModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
content | Content field consumed when encoding this options table. |
ModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
customId | Custom Id field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |
title | Title field consumed when encoding this options table. |
ActionRowModalData
Option table. Construct a Lua table with the fields below and pass it to the matching manager or structure method.
| Field | Role |
|---|---|
type | Type field consumed when encoding this options table. |
id | Id field consumed when encoding this options table. |
components | Components field consumed when encoding this options table. |