diff --git a/discord-luau b/discord-luau index 232fb4d..ea0b6b4 160000 --- a/discord-luau +++ b/discord-luau @@ -1 +1 @@ -Subproject commit 232fb4d40245338a03a4d4a271e7f3d8faeaa0b5 +Subproject commit ea0b6b40894dfbd1c8d9b8dc85c094de700ed181 diff --git a/src/content/docs/classes/Builders/DiscordPermission.mdx b/src/content/docs/classes/Builders/DiscordPermission.mdx index c315f3e..9bf87ca 100644 --- a/src/content/docs/classes/Builders/DiscordPermission.mdx +++ b/src/content/docs/classes/Builders/DiscordPermission.mdx @@ -20,7 +20,11 @@ import LuaProperty from '$/components/LuaProperty.astro'; ## Properties -The DiscordPermission instance has no set properties! +### permissions + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/DiscordClient.mdx b/src/content/docs/classes/DiscordClient.mdx index 50e131e..028860e 100644 --- a/src/content/docs/classes/DiscordClient.mdx +++ b/src/content/docs/classes/DiscordClient.mdx @@ -39,12 +39,12 @@ local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder) ### discordGateway - + --- ### eventManager - + --- @@ -54,7 +54,7 @@ local DiscordClient = DiscordLuau.DiscordClient.new(SettingsBuilder) ### connectAsync -> +> Connects the current DiscordClient to the Discord API. ```lua @@ -66,19 +66,19 @@ end) ``` ### fetchGuildAsync -> +> Fetches a guild by its ID. ### fetchChannelAsync -> +> Fetches a channel by its ID. ### updatePresenceAsync -> +> Updates the client's presence. ### createGuildAsync -> +> Creates a Guild, owned by the application. ### setVerbose diff --git a/src/content/docs/classes/Network/DiscordGateway.mdx b/src/content/docs/classes/Network/DiscordGateway.mdx index 07ae143..0407a94 100644 --- a/src/content/docs/classes/Network/DiscordGateway.mdx +++ b/src/content/docs/classes/Network/DiscordGateway.mdx @@ -24,7 +24,31 @@ This class is internal and should not be used directly by developers. ## Properties -The DiscordGateway instance has no set properties! +### discordScheduler + + +--- + +### gatewayEventIn + + +--- + +### reporter + + +--- + +### endpointRateLimits + + +--- + +### endpointCaches + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -40,27 +64,27 @@ Parses error messages from the Discord API response. Parses errors from a Discord API response. ### requestAsync -> +> Sends an asynchronous request to the Discord API. ### getAsync -> +> Sends an asynchronous GET request to the Discord API. ### postAsync -> +> Sends an asynchronous POST request to the Discord API. ### putAsync -> +> Sends an asynchronous PUT request to the Discord API. ### deleteAsync -> +> Sends an asynchronous DELETE request to the Discord API. ### patchAsync -> +> Sends an asynchronous PATCH request to the Discord API. ### setEndpointCache diff --git a/src/content/docs/classes/Network/DiscordShard.mdx b/src/content/docs/classes/Network/DiscordShard.mdx index 6fa70d8..4651590 100644 --- a/src/content/docs/classes/Network/DiscordShard.mdx +++ b/src/content/docs/classes/Network/DiscordShard.mdx @@ -48,7 +48,7 @@ Observes and handles WebSocket operations. Initiates the WebSocket connection. ### heartbeatAsync -> +> Sends a heartbeat to the Discord WebSocket. ### heartbeatIn @@ -56,19 +56,19 @@ Sends a heartbeat to the Discord WebSocket. Schedules the next heartbeat. ### identifyAsync -> +> Identifies the Discord client with the Discord WebSocket. ### connectAsync -> +> Connects the DiscordShard to the Discord WebSocket. ### resumeAsync -> +> Resumes a previous session with the Discord WebSocket. ### reconnectAsync -> +> Attempts to reconnect the DiscordShard to the Discord WebSocket. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Network/DiscordUDP.mdx b/src/content/docs/classes/Network/DiscordUDP.mdx index ecbef1b..5d3a951 100644 --- a/src/content/docs/classes/Network/DiscordUDP.mdx +++ b/src/content/docs/classes/Network/DiscordUDP.mdx @@ -24,7 +24,136 @@ This class is internal and should not be used directly by developers. ## Properties -The DiscordUDP instance has no set properties! +### discordWebsocket + + +--- + +### websocketUrl + + +--- + +### reporter + + +--- + +### heartbeatTask + + +--- + +### resumeSessionId + + +--- + +### dispatchSequence + + +--- + +### heartbeatInterval + + +--- + +### heartbeatClockTime + + +--- + +### heartbeatPing + + +--- + +### identified + + +--- + +### resumeGatewayUrl + + +--- + +### heartbeatAck + + +--- + +### activeConnections + + +--- + +### onEvent + + +--- + +### onIdentified + + +--- + +### shardId + + +--- + +### udpActive + + +--- + +### publicUdp + + +--- + +### onMessageRecv + + +--- + +### onSocketDead + + +--- + +### socketInstance + + +--- + +### reporter + + +--- + +### socketUrl + + +--- + +### socketActive + + +--- + +### socketActiveChanged + + +--- + +### socketThread + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -32,15 +161,15 @@ The DiscordUDP instance has no set properties! ### sendAsync -> +> Sends a UDP packet asynchronously. ### connectAsync -> +> Connects to a UDP socket asynchronously. ### disconnectAsync -> +> Disconnects from the UDP socket asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx index a47460b..47b59f5 100644 --- a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx +++ b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx @@ -24,7 +24,91 @@ This class is internal and should not be used directly by developers. Instead, u ## Properties -The DiscordVoiceConnection instance has no set properties! +### voiceWebsocket + + +--- + +### voiceUDP + + +--- + +### reporter + + +--- + +### heartbeatTask + + +--- + +### resumeSessionId + + +--- + +### heartbeatInterval + + +--- + +### heartbeatAck + + +--- + +### heartbeatPing + + +--- + +### heartbeatNonce + + +--- + +### heartbeatClockTime + + +--- + +### encryptionKey + + +--- + +### mediaSessionId + + +--- + +### channelId + + +--- + +### guildId + + +--- + +### voiceServerUpdate + + +--- + +### voiceStateUpdate + + +--- + +### onEvent + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -40,7 +124,7 @@ Observes and handles errors from the voice websocket. Observes and handles operations received from the voice websocket. ### heartbeatAsync -> +> Sends a heartbeat to the voice websocket and manages the heartbeat acknowledgements. ### heartbeatIn @@ -48,19 +132,19 @@ Sends a heartbeat to the voice websocket and manages the heartbeat acknowledgeme Schedules the next heartbeat to be sent after a specified interval. ### connectAsync -> +> Connects to a voice channel asynchronously. ### resumeAsync -> +> Resumes a voice connection asynchronously. ### reconnectAsync -> +> Reconnects to the voice websocket asynchronously. ### disconnectAsync -> +> Disconnects from the voice websocket asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Network/DiscordWebsocket.mdx b/src/content/docs/classes/Network/DiscordWebsocket.mdx index 42b16f8..333f9e8 100644 --- a/src/content/docs/classes/Network/DiscordWebsocket.mdx +++ b/src/content/docs/classes/Network/DiscordWebsocket.mdx @@ -24,7 +24,71 @@ This class is internal and should not be used directly by developers. Instead, u ## Properties -The DiscordWebsocket instance has no set properties! +### websocketWebsocketBuffer + + +--- + +### socketActiveChanged + + +--- + +### socketActive + + +--- + +### gatewayEventIn + + +--- + +### gatewayEventOut + + +--- + +### onMessageRecv + + +--- + +### onSocketDead + + +--- + +### onOperationRecv + + +--- + +### reporter + + +--- + +### socketUrl + + +--- + +### socketInstance + + +--- + +### socketRequestSuccess + + +--- + +### socketThread + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -32,15 +96,15 @@ The DiscordWebsocket instance has no set properties! ### sendAsync -> +> Sends a data packet asynchronously through the websocket. ### connectAsync -> +> Connects to a websocket URL asynchronously. ### disconnectAsync -> +> Disconnects from the websocket asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Network/HTTPRatelimit.mdx b/src/content/docs/classes/Network/HTTPRatelimit.mdx index f461eea..f0ec0aa 100644 --- a/src/content/docs/classes/Network/HTTPRatelimit.mdx +++ b/src/content/docs/classes/Network/HTTPRatelimit.mdx @@ -24,7 +24,21 @@ This class is internal and should not be used directly by developers. Instead, u ## Properties -The HTTPRatelimit instance has no set properties! +### remaining + + +--- + +### limit + + +--- + +### resetAfterThread + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Network/HTTPScheduler.mdx b/src/content/docs/classes/Network/HTTPScheduler.mdx index dfd0474..39559eb 100644 --- a/src/content/docs/classes/Network/HTTPScheduler.mdx +++ b/src/content/docs/classes/Network/HTTPScheduler.mdx @@ -24,7 +24,36 @@ This class is internal and should not be used directly by developers. Instead, u ## Properties -The HTTPScheduler instance has no set properties! +### stack + + +--- + +### processing + + +--- + +### workers + + +--- + +### reporter + + +--- + +### limit + + +--- + +### frequency + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Network/WebsocketBuffer.mdx b/src/content/docs/classes/Network/WebsocketBuffer.mdx index 5e2dc1d..54e0776 100644 --- a/src/content/docs/classes/Network/WebsocketBuffer.mdx +++ b/src/content/docs/classes/Network/WebsocketBuffer.mdx @@ -24,7 +24,36 @@ This class is internal and should not be used directly by developers. Instead, u ## Properties -The WebsocketBuffer instance has no set properties! +### data + + +--- + +### type + + +--- + +### eventOutMiddleware + + +--- + +### eventInMiddleware + + +--- + +### metadata + + +--- + +### data + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/BaseDiscordChannel.mdx b/src/content/docs/classes/Objects/BaseDiscordChannel.mdx index 90d462e..b1335c8 100644 --- a/src/content/docs/classes/Objects/BaseDiscordChannel.mdx +++ b/src/content/docs/classes/Objects/BaseDiscordChannel.mdx @@ -20,7 +20,16 @@ Represents a base discord channel, every discord channel object will extend from ## Properties -The BaseDiscordChannel instance has no set properties! +### id + + +--- + +### type + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,7 +37,7 @@ The BaseDiscordChannel instance has no set properties! ### deleteAsync -> +> Deletes the channel asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/BaseDiscordGuildChannel.mdx b/src/content/docs/classes/Objects/BaseDiscordGuildChannel.mdx index a0145f0..b56a961 100644 --- a/src/content/docs/classes/Objects/BaseDiscordGuildChannel.mdx +++ b/src/content/docs/classes/Objects/BaseDiscordGuildChannel.mdx @@ -28,43 +28,43 @@ The BaseDiscordGuildChannel instance has no set properties! ### overwriteRolePermissionsAsync -> +> set overwrites for a specific role permissions for this channel in a discord guild. ### overwriteMemberPermissionssync -> +> set overwrites for a specific members permissions for this channel in a discord guild. ### overwriteMemberPermissionssync -> +> deletes overwritten permissions for the given id, the given id must be either a role id or a user id ### getInvitesAsync -> +> Gets the invites for the channel asynchronously. ### createInviteAsync -> +> Creates an invite for the channel asynchronously. ### setPositionAsync -> +> Sets the position of the channel asynchronously. ### modifyAsync -> +> Modifies the thread channel settings asynchronously. ### getPublicArchivedThreadsAsync -> +> Gets all archived public threads in the guild channel asynchronously. ### getPrivateArchivedThreadsAsync -> +> Gets all archived private threads in the guild channel asynchronously. ### getJoinedPrivateArchivedThreads -> +> Gets all archived private threads that the bot is a member of, in the guild channel asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx b/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx index 35d6b9d..c7ceccc 100644 --- a/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx +++ b/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx @@ -20,7 +20,46 @@ A base guild text channel, where any/all text channels extend from. ## Properties -The BaseGuildTextChannel instance has no set properties! +### lastPinTimestamp + + +--- + +### lastMessageId + + +--- + +### guildId + + +--- + +### topic + + +--- + +### nsfw + + +--- + +### rateLimitPerUser + + +--- + +### parentId + + +--- + +### flags + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,27 +67,27 @@ The BaseGuildTextChannel instance has no set properties! ### triggerTypingIndicator -> +> Triggers the typing indicator in the channel. ### getMessagesAsync -> +> Gets messages from the channel asynchronously. ### getMessageAsync -> +> Gets a specific message from the channel asynchronously. ### bulkDeleteMessagesAsync -> +> Deletes multiple messages from the channel asynchronously. ### sendMessageAsync -> +> Sends a message to the channel asynchronously. ### getPinnedMessagesAsync -> +> Retrieves the pinned messages in the text channel asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/BaseGuildThread.mdx b/src/content/docs/classes/Objects/BaseGuildThread.mdx index dca279b..57c20b7 100644 --- a/src/content/docs/classes/Objects/BaseGuildThread.mdx +++ b/src/content/docs/classes/Objects/BaseGuildThread.mdx @@ -20,7 +20,46 @@ A base discord Thread channel, all discord threads extend from. ## Properties -The BaseGuildThread instance has no set properties! +### ownerId + + +--- + +### messageCount + + +--- + +### memberCount + + +--- + +### totalMessageSent + + +--- + +### threadMetadata + + +--- + +### availableTags + + +--- + +### appliedTags + + +--- + +### defaultReactionEmoji + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,27 +67,27 @@ The BaseGuildThread instance has no set properties! ### joinThreadAsync -> +> Joins the current discord bot into the thread ### addMemberToThreadAsync -> +> Adds the passed member to the thread channel ### leaveThreadAsync -> +> Leaves the thread channel if the discord bot is in the channel. ### removeMemberFromThreadAsync -> +> Removes the passed user id from the current thread channel ### getThreadMemberAsync -> +> Returns a list of members that are active in the current thread channel ### removeMemberFromThreadAsync -> +> Returns a list of members that are active in the current thread channel [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/BaseGuildVoiceChannel.mdx b/src/content/docs/classes/Objects/BaseGuildVoiceChannel.mdx index 4ee1aea..7780fe6 100644 --- a/src/content/docs/classes/Objects/BaseGuildVoiceChannel.mdx +++ b/src/content/docs/classes/Objects/BaseGuildVoiceChannel.mdx @@ -28,11 +28,11 @@ The BaseGuildVoiceChannel instance has no set properties! ### connectAsync -> +> Connects to the voice channel asynchronously. ### disconnectAsync -> +> Disconnects from the voice channel asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/BaseUserChannel.mdx b/src/content/docs/classes/Objects/BaseUserChannel.mdx index e4afdf8..d4fc722 100644 --- a/src/content/docs/classes/Objects/BaseUserChannel.mdx +++ b/src/content/docs/classes/Objects/BaseUserChannel.mdx @@ -28,27 +28,27 @@ The BaseUserChannel instance has no set properties! ### triggerTypingIndicator -> +> Triggers the typing indicator in the channel. ### getMessagesAsync -> +> Gets messages from the channel asynchronously. ### getMessageAsync -> +> Gets a specific message from the channel asynchronously. ### bulkDeleteMessagesAsync -> +> Deletes multiple messages from the channel asynchronously. ### sendMessageAsync -> +> Sends a message to the channel asynchronously. ### getPinnedMessagesAsync -> +> Retrieves the pinned messages in the text channel asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordApplication.mdx b/src/content/docs/classes/Objects/DiscordApplication.mdx index f9e7ac5..82f28ee 100644 --- a/src/content/docs/classes/Objects/DiscordApplication.mdx +++ b/src/content/docs/classes/Objects/DiscordApplication.mdx @@ -26,6 +26,61 @@ The `DiscordApplication` class provides methods to interact with Discord applica ### flags +### id + + +--- + +### flags + + +--- + +### id + + +--- + +### guildId + + +--- + +### voiceConnection + + +--- + +### bitrate + + +--- + +### userLimit + + +--- + +### rtcRegion + + +--- + +### videoQualityMode + + +--- + +### id + + +--- + +### recipients + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -33,23 +88,23 @@ The `DiscordApplication` class provides methods to interact with Discord applica ### createSlashCommandAsync -> +> Creates a new slash command for the Discord application. ### deleteSlashCommandAsync -> +> Deletes an existing slash command from the Discord application. ### editSlashCommandAsync -> +> Edits an existing slash command for the Discord application. ### fetchSlashCommandsAsync -> +> Fetches all existing slash commands for the Discord application. ### setSlashCommandsAsync -> +> Sets the slash commands for the Discord application, updating existing ones and creating or deleting as necessary. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx index 9422934..1ebe4f0 100644 --- a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx +++ b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx @@ -23,33 +23,53 @@ The `DiscordAutomoderationRule` class provides methods to interact with Discord ### id +--- + ### guildId +--- + ### name +--- + ### eventType +--- + ### triggerType +--- + ### enabled +--- + ### exemptRoles +--- + ### exemptChannels +--- + ### triggerMetadata - + +--- + ### actions - + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -57,11 +77,11 @@ The `DiscordAutomoderationRule` class provides methods to interact with Discord ### modifyAsync -> +> Modifies an existing auto-moderation rule. ### deleteAsync -> +> Deletes an existing auto-moderation rule. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordCache.mdx b/src/content/docs/classes/Objects/DiscordCache.mdx index ed2f2b2..8b52cfd 100644 --- a/src/content/docs/classes/Objects/DiscordCache.mdx +++ b/src/content/docs/classes/Objects/DiscordCache.mdx @@ -25,6 +25,11 @@ The `DiscordCache` class provides a caching mechanism for storing and retrieving --- The type of the DiscordCache. Default is "DiscordCache". +### cache + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordEmoji.mdx b/src/content/docs/classes/Objects/DiscordEmoji.mdx index e72e26a..ce3d6e1 100644 --- a/src/content/docs/classes/Objects/DiscordEmoji.mdx +++ b/src/content/docs/classes/Objects/DiscordEmoji.mdx @@ -25,6 +25,41 @@ The `DiscordEmoji` class represents a Discord emoji and provides a structure for --- The type of the DiscordEmoji. Default is "DiscordEmoji". +### id + + +--- + +### name + + +--- + +### roles + + +--- + +### requireColons + + +--- + +### managed + + +--- + +### animated + + +--- + +### avaliable + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx index f4928d3..7a30a00 100644 --- a/src/content/docs/classes/Objects/DiscordGuild.mdx +++ b/src/content/docs/classes/Objects/DiscordGuild.mdx @@ -32,167 +32,167 @@ The type of the DiscordGuild. Default is "DiscordGuild". ### createSlashCommandAsync -> +> Creates a new slash command in the guild asynchronously. ### deleteSlashCommandAsync -> +> Deletes a slash command in the guild asynchronously. ### editSlashCommandAsync -> +> Edits a slash command in the guild asynchronously. ### fetchSlashCommandsAsync -> +> Fetches all slash commands in the guild asynchronously. ### fetchGuildChannels -> +> Fetches all channels in the guild asynchronously. ### setSlashCommandsAsync -> +> Sets multiple slash commands in the guild asynchronously. ### getGuildAuditLogs -> +> Gets the audit logs of the guild asynchronously. ### modifyAsync -> +> Modifies the guild settings asynchronously. ### modifyCurrentMemberAsync -> +> Modifies the current member of the discord guild ### deleteAsync -> +> Deletes the guild asynchronously. ### getChannelsAsync -> +> Gets all channels in the guild asynchronously. ### getMemberAsync -> +> Gets a specific member of the guild asynchronously. ### fetchGuildMembersAsync -> +> Fetches members of the guild asynchronously. ### searchGuildMembersAsync -> +> Searches for members in the guild asynchronously. ### listAutomoderationRulesAsync -> +> Lists all automoderation rules in the guild asynchronously. ### getAutomoderationRuleAsync -> +> Gets a specific automoderation rule in the guild asynchronously. ### createAutomoderationRuleAsync -> +> Creates an automoderation rule in the guild asynchronously. ### getPreviewAsync -> +> Get the preview of the current Guild ### createChannelAsync -> +> Creates a Guild Channel under a Guild. ### getActiveGuildThreads -> +> Fetches all active guild threads. ### addMemberAsync -> +> Adds a discordian to a guild. ### getGuildBansAsync -> +> Fetches an array of Guild Bans ### getGuildBanAsync -> +> Fetches the ban object for a specific user id ### bulkGuildBanAsync -> +> Bans up to 200 members asynchronously ### bulkGuildBanAsync -> +> Allows you to get all roles within a guild. ### bulkGuildBanAsync -> +> Allows you to get all roles within a guild. ### setMFALevelAsync -> +> Setst he guilds MFA level. ### getPruneCountAsync -> +> Fetches the prune count. ### getPruneCountAsync -> +> Requests discord to prune the Discord guild. ### getGuildVoiceRegionsAsync -> +> Fetches the avaliable voice regions for the guild. ### getGuildInvitesAsync -> +> Fetches all guild invite objects. ### getGuildIntegrationsAsync -> +> Fetches all guild integrations ### getGuildWidgetSettingsAsync -> +> Fetches the widget settings for the current guild. ### updateGuildWidgetSettingsAsync -> +> Updates the widget settings for the current guild ### getGuldWidgetAsync -> +> Gets the guild widget for this guild. ### getGuildVanityUrlAsync -> +> Gets the vanity url for this guild. ### getGuildWelcomeScreenAsync -> +> Gets the guild welcome screen for this guild. ### getGuildWidgetImageAsync -> +> Gets the binary PNG image for a server widget ### modifyGuildWelcomeScreenAsync -> +> Updates the guild welcome screen for this guild. ### getGuldOnboardingAsync -> +> Gets the onboarding for this guild ### getGuldOnboardingAsync -> +> Updates the onboarding for this guild [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordGuildBan.mdx b/src/content/docs/classes/Objects/DiscordGuildBan.mdx index f8986d6..6dabf5f 100644 --- a/src/content/docs/classes/Objects/DiscordGuildBan.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildBan.mdx @@ -20,11 +20,41 @@ The `DiscordGuildBan` class provides a way for developers to interact with guild ## Properties +### shardId + + +--- + +### id + + +--- + +### roles + + +--- + +### emojis + + +--- + ### type --- The type of the DiscordGuildBan. Default is "DiscordGuildBan". +### user + + +--- + +### reason + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordGuildMember.mdx b/src/content/docs/classes/Objects/DiscordGuildMember.mdx index a2e1482..b87b14a 100644 --- a/src/content/docs/classes/Objects/DiscordGuildMember.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildMember.mdx @@ -25,6 +25,16 @@ The `DiscordGuildMember` class represents a member of a Discord guild (server) a --- The type of the DiscordGuildMember. Default is "DiscordGuildMember". +### user + + +--- + +### guildId + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -32,51 +42,51 @@ The type of the DiscordGuildMember. Default is "DiscordGuildMember". ### kickAsync -> +> Kicks the guild member asynchronously. ### banAsync -> +> Bans the guild member asynchronously. ### unbanAsync -> +> Unbans the guild member asynchronously. ### addRoleAsync -> +> Adds a role to the guild member asynchronously. ### removeRoleAsync -> +> Removes a role from the guild member asynchronously. ### timeoutAsync -> +> Times out the guild member asynchronously. ### muteAsync -> +> Mutes the guild member asynchronously. ### unmuteAsync -> +> Unmutes the guild member asynchronously. ### deafenAsync -> +> Deafens the guild member asynchronously. ### undeafenAsync -> +> Undeafens the guild member asynchronously. ### setNicknameAsync -> +> Sets the nickname of the guild member asynchronously. ### modifyAsync -> +> Modifies the guild member asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordGuildRole.mdx b/src/content/docs/classes/Objects/DiscordGuildRole.mdx index 17b08b3..2a81137 100644 --- a/src/content/docs/classes/Objects/DiscordGuildRole.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildRole.mdx @@ -25,6 +25,51 @@ The `DiscordGuildRole` class represents a role in a Discord guild (server) and p --- The type of the DiscordGuildRole. Default is "DiscordGuildRole". +### guildId + + +--- + +### id + + +--- + +### name + + +--- + +### permissions + + +--- + +### position + + +--- + +### color + + +--- + +### hoist + + +--- + +### managed + + +--- + +### mentionable + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordIntegration.mdx b/src/content/docs/classes/Objects/DiscordIntegration.mdx index 1b74c92..d3b3b5e 100644 --- a/src/content/docs/classes/Objects/DiscordIntegration.mdx +++ b/src/content/docs/classes/Objects/DiscordIntegration.mdx @@ -20,7 +20,91 @@ DiscordIntegration represents a guild integration. ## Properties -The DiscordIntegration instance has no set properties! +### guildId + + +--- + +### id + + +--- + +### name + + +--- + +### type + + +--- + +### enabled + + +--- + +### syncing + + +--- + +### roleId + + +--- + +### enableEmoticons + + +--- + +### expireBehaviour + + +--- + +### expireGracePeriod + + +--- + +### user + + +--- + +### account + + +--- + +### syncedAt + + +--- + +### subscriberCount + + +--- + +### revoked + + +--- + +### application + + +--- + +### scopes + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,7 +112,7 @@ The DiscordIntegration instance has no set properties! ### deleteAsync -> +> Deletes the invite asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordInteraction.mdx b/src/content/docs/classes/Objects/DiscordInteraction.mdx index 315143a..ffaef55 100644 --- a/src/content/docs/classes/Objects/DiscordInteraction.mdx +++ b/src/content/docs/classes/Objects/DiscordInteraction.mdx @@ -25,6 +25,76 @@ The `DiscordInteraction` class represents an interaction with the Discord API, s --- The type of the DiscordInteraction. Default is "DiscordInteraction". +### channel + + +--- + +### guild + + +--- + +### user + + +--- + +### token + + +--- + +### applicationId + + +--- + +### id + + +--- + +### data + + +--- + +### channelId + + +--- + +### guilldId + + +--- + +### version + + +--- + +### appPermissions + + +--- + +### guildLocale + + +--- + +### locale + + +--- + +### defered + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -32,15 +102,15 @@ The type of the DiscordInteraction. Default is "DiscordInteraction". ### editMessageAsync -> +> Edits the original interaction response message asynchronously. ### sendModalAsync -> +> Sends a modal in response to the interaction asynchronously. ### sendMessageAsync -> +> Sends a message in response to the interaction asynchronously. :::caution @@ -48,7 +118,7 @@ MessageBuilder cannot support Attachments UNLESS deffered, so if you're wanting ::: ### deferAsync -> +> Defers the interaction response asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordInvite.mdx b/src/content/docs/classes/Objects/DiscordInvite.mdx index 8bc77eb..4964da4 100644 --- a/src/content/docs/classes/Objects/DiscordInvite.mdx +++ b/src/content/docs/classes/Objects/DiscordInvite.mdx @@ -20,7 +20,41 @@ DiscordInvite represents an invite link to a Discord server, providing methods t ## Properties -The DiscordInvite instance has no set properties! +### code + + +--- + +### type + + +--- + +### guild + + +--- + +### inviter + + +--- + +### targetType + + +--- + +### targetUser + + +--- + +### targetApplication + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,7 +62,7 @@ The DiscordInvite instance has no set properties! ### deleteAsync -> +> Deletes the invite asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordMessage.mdx b/src/content/docs/classes/Objects/DiscordMessage.mdx index f2413f7..9b11978 100644 --- a/src/content/docs/classes/Objects/DiscordMessage.mdx +++ b/src/content/docs/classes/Objects/DiscordMessage.mdx @@ -20,7 +20,81 @@ DiscordMessage represents a message in a Discord channel, providing methods to r ## Properties -The DiscordMessage instance has no set properties! +### mentionRoles + + +--- + +### tts + + +--- + +### mentionEveryone + + +--- + +### nonce + + +--- + +### id + + +--- + +### author + + +--- + +### content + + +--- + +### mentions + + +--- + +### flags + + +--- + +### timestamp + + +--- + +### type + + +--- + +### pinned + + +--- + +### guildId + + +--- + +### channelId + + +--- + +### member + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,55 +102,55 @@ The DiscordMessage instance has no set properties! ### crosspostAsync -> +> Crossposts the message in an Announcement Channel to all following channels. ### replyAsync -> +> Replies to the message asynchronously. ### startThreadAsync -> +> Start a thread from the current message object. ### deleteAsync -> +> Deletes the message asynchronously. ### pinAsync -> +> Pins the message asynchronously. ### unpinAsync -> +> Unpins the message asynchronously. ### editAsync -> +> Edits the message asynchronously. ### addReactionAsync -> +> Adds a reaction to the message asynchronously. ### removeReactionAsync -> +> Removes a reaction from the message asynchronously. ### removeUserReactionAsync -> +> Removes a reaction from a specific user on the message asynchronously. ### getReactionsAsync -> +> Gets the reactions on the message asynchronously. ### removeAllReactionsAsync -> +> Removes all reactions from the message asynchronously. ### removeAllReactionsForEmojiAsync -> +> Removes all reactions for a specific emoji from the message asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordSticker.mdx b/src/content/docs/classes/Objects/DiscordSticker.mdx index 4b16abb..8264a91 100644 --- a/src/content/docs/classes/Objects/DiscordSticker.mdx +++ b/src/content/docs/classes/Objects/DiscordSticker.mdx @@ -25,6 +25,61 @@ The `DiscordSticker` class represents a Discord sticker and provides a structure --- The type of the DiscordSticker. Default is "DiscordSticker". +### id + + +--- + +### packId + + +--- + +### name + + +--- + +### description + + +--- + +### tags + + +--- + +### type + + +--- + +### formatType + + +--- + +### avaliable + + +--- + +### guildId + + +--- + +### user + + +--- + +### sortValue + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordUser.mdx b/src/content/docs/classes/Objects/DiscordUser.mdx index bc3840d..2a06d8c 100644 --- a/src/content/docs/classes/Objects/DiscordUser.mdx +++ b/src/content/docs/classes/Objects/DiscordUser.mdx @@ -20,7 +20,46 @@ DiscordUser represents a user on Discord, encapsulating user data such as userna ## Properties -The DiscordUser instance has no set properties! +### username + + +--- + +### flags + + +--- + +### mfaEnabled + + +--- + +### avatar + + +--- + +### id + + +--- + +### bot + + +--- + +### verified + + +--- + +### discriminator + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildForumChannel.mdx b/src/content/docs/classes/Objects/GuildForumChannel.mdx index 4f30e0e..9c08583 100644 --- a/src/content/docs/classes/Objects/GuildForumChannel.mdx +++ b/src/content/docs/classes/Objects/GuildForumChannel.mdx @@ -20,7 +20,11 @@ Represents the implementation of a Discord Forum channel. ## Properties -The GuildForumChannel instance has no set properties! +### defaultSortOrder + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildMediaChannel.mdx b/src/content/docs/classes/Objects/GuildMediaChannel.mdx index 795ff6e..bdff37b 100644 --- a/src/content/docs/classes/Objects/GuildMediaChannel.mdx +++ b/src/content/docs/classes/Objects/GuildMediaChannel.mdx @@ -20,7 +20,11 @@ Represents the implementation of a Discord Media channel. ## Properties -The GuildMediaChannel instance has no set properties! +### defaultForumLayout + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildOnboarding.mdx b/src/content/docs/classes/Objects/GuildOnboarding.mdx index cf2969e..a2d93fb 100644 --- a/src/content/docs/classes/Objects/GuildOnboarding.mdx +++ b/src/content/docs/classes/Objects/GuildOnboarding.mdx @@ -25,6 +25,31 @@ The `GuildOnboarding` class provides a way for developers to interact with a Gui --- The type of the GuildOnboarding. Default is "GuildOnboarding". +### guildId + + +--- + +### prompts + + +--- + +### defaultChannelIds + + +--- + +### enabled + + +--- + +### mode + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx b/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx index 7ab37a3..1729e1c 100644 --- a/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx +++ b/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx @@ -25,11 +25,41 @@ The `GuildOnboardingPrompt` class provides a way for developers to interact with --- The type of the GuildOnboardingPrompt. Default is "GuildOnboardingPrompt". +### id + + +--- + ### type - + --- -The type of the GuildOnboardingPrompt. Default is "GuildOnboardingPrompt". + +### options + + +--- + +### title + + +--- + +### singleSelect + + +--- + +### required + + +--- + +### inOboarding + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -45,8 +75,4 @@ The GuildOnboardingPrompt instance has no set methods! > Creates a new GuildOnboardingPrompt instance. -### new - -> -Creates a new GuildOnboardingPrompt instance. diff --git a/src/content/docs/classes/Objects/GuildOnboardingPromptOption.mdx b/src/content/docs/classes/Objects/GuildOnboardingPromptOption.mdx new file mode 100644 index 0000000..24e7117 --- /dev/null +++ b/src/content/docs/classes/Objects/GuildOnboardingPromptOption.mdx @@ -0,0 +1,68 @@ +--- +title: GuildOnboardingPromptOption +description: DiscordLuau docs for GuildOnboardingPromptOption. +--- +[//]: # (This file was automatically compiled through the Generator luau code under this repository) +[//]: # (if you want to edit the documentation of discord-luau, please write changes) +[//]: # (to the discord-luau repository itself, we extract the comments from discord-luau and translate) +[//]: # (them into markdown files that Nextra can interpret!) + +[//]: # (----- DOCUMENT IMPORTS ----- ) + +import LuaDeclaration from '$/components/LuaDeclaration.astro'; +import LuaProperty from '$/components/LuaProperty.astro'; + +[//]: # (----- DOCUMENT DESCRIPTION ----- ) + +The `GuildOnboardingPromptOption` class provides a way for developers to interact with a guild onboarding prompt option. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the GuildOnboardingPromptOption. Default is "GuildOnboardingPromptOption". +### id + + +--- + +### channelIds + + +--- + +### roleIds + + +--- + +### title + + +--- + +### description + + +--- + + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildOnboardingPromptOption instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new GuildOnboardingPromptOption instance. + diff --git a/src/content/docs/classes/Objects/GuildPreview.mdx b/src/content/docs/classes/Objects/GuildPreview.mdx index 6bf493a..6526ca2 100644 --- a/src/content/docs/classes/Objects/GuildPreview.mdx +++ b/src/content/docs/classes/Objects/GuildPreview.mdx @@ -20,7 +20,61 @@ GuildPreview represents a user on Discord, encapsulating user data such as usern ## Properties -The GuildPreview instance has no set properties! +### id + + +--- + +### name + + +--- + +### icon + + +--- + +### splash + + +--- + +### discoverySplash + + +--- + +### emojis + + +--- + +### features + + +--- + +### approximateMemberCount + + +--- + +### approximatePresenceCount + + +--- + +### description + + +--- + +### stickers + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx b/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx index e8a7c2f..e49a356 100644 --- a/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx +++ b/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx @@ -25,6 +25,16 @@ The `GuildWelcomeScreen` class provides a way for developers to interact with a --- The type of the GuildWelcomeScreen. Default is "GuildWelcomeScreen". +### description + + +--- + +### welcomeChannels + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildWidget.mdx b/src/content/docs/classes/Objects/GuildWidget.mdx index cc25216..a481607 100644 --- a/src/content/docs/classes/Objects/GuildWidget.mdx +++ b/src/content/docs/classes/Objects/GuildWidget.mdx @@ -25,6 +25,36 @@ The `GuildWidget` class provides a way for developers to interact with a Widget. --- The type of the GuildWidget. Default is "GuildWidget". +### id + + +--- + +### name + + +--- + +### instantInvite + + +--- + +### channels + + +--- + +### members + + +--- + +### presenceCount + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/UserGroupChannel.mdx b/src/content/docs/classes/Objects/UserGroupChannel.mdx index 6cb5293..237e765 100644 --- a/src/content/docs/classes/Objects/UserGroupChannel.mdx +++ b/src/content/docs/classes/Objects/UserGroupChannel.mdx @@ -20,7 +20,26 @@ Represents the implementation of a Discord Group Channel ## Properties -The UserGroupChannel instance has no set properties! +### icon + + +--- + +### ownerId + + +--- + +### applicationId + + +--- + +### managed + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) @@ -28,7 +47,7 @@ The UserGroupChannel instance has no set properties! ### modifyAsync -> +> Modifies the thread channel settings asynchronously. [//]: # (----- DOCUMENT FUNCTIONS ----- )