From feaea8509df042f73ca147f283cbecfa13d5e8e0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Jun 2024 20:02:21 +0000 Subject: [PATCH] docs: update refs for https://github.com/DiscordLuau/discord-luau/commit/bbf646293fa5f35a41a2fb8b21c25f36d4e54632 --- .../docs/classes/Network/DiscordShard.mdx | 81 ++++++++++++++++++- .../docs/classes/Network/DiscordUDP.mdx | 80 ------------------ .../Network/DiscordVoiceConnection.mdx | 4 +- .../docs/classes/Network/WebsocketBuffer.mdx | 12 +-- .../classes/Objects/BaseGuildTextChannel.mdx | 20 ++--- .../docs/classes/Objects/BaseGuildThread.mdx | 32 ++++---- .../classes/Objects/DiscordApplication.mdx | 52 ++++++------ .../Objects/DiscordAutomoderationRule.mdx | 4 +- .../docs/classes/Objects/DiscordGuild.mdx | 2 +- .../docs/classes/Objects/DiscordInvite.mdx | 4 +- .../docs/classes/Objects/DiscordMessage.mdx | 4 +- .../Objects/GuildAnnouncementChannel.mdx | 28 +++---- .../GuildAnnouncementThreadChannel.mdx | 4 +- .../classes/Objects/GuildDirectoryChannel.mdx | 28 +++---- .../Objects/GuildPrivateThreadChannel.mdx | 4 +- .../Objects/GuildPublicThreadChannel.mdx | 4 +- .../docs/classes/Objects/GuildTextChannel.mdx | 28 +++---- 17 files changed, 195 insertions(+), 196 deletions(-) diff --git a/src/content/docs/classes/Network/DiscordShard.mdx b/src/content/docs/classes/Network/DiscordShard.mdx index ff28c15..9e9fe8f 100644 --- a/src/content/docs/classes/Network/DiscordShard.mdx +++ b/src/content/docs/classes/Network/DiscordShard.mdx @@ -27,7 +27,86 @@ This class is internal and should not be used directly by developers. ## Properties -The DiscordShard instance has no set properties! +### discordWebsocket + + +--- + +### websocketUrl + + +--- + +### reporter + + +--- + +### heartbeatTask + + +--- + +### resumeSessionId + + +--- + +### dispatchSequence + + +--- + +### heartbeatInterval + + +--- + +### heartbeatClockTime + + +--- + +### heartbeatPing + + +--- + +### identified + + +--- + +### resumeGatewayUrl + + +--- + +### heartbeatAck + + +--- + +### activeConnections + + +--- + +### onEvent + + +--- + +### onIdentified + + +--- + +### shardId + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Network/DiscordUDP.mdx b/src/content/docs/classes/Network/DiscordUDP.mdx index 7d76101..6a14e63 100644 --- a/src/content/docs/classes/Network/DiscordUDP.mdx +++ b/src/content/docs/classes/Network/DiscordUDP.mdx @@ -27,86 +27,6 @@ This class is internal and should not be used directly by developers. ## Properties -### discordWebsocket - - ---- - -### websocketUrl - - ---- - -### reporter - - ---- - -### heartbeatTask - - ---- - -### resumeSessionId - - ---- - -### dispatchSequence - - ---- - -### heartbeatInterval - - ---- - -### heartbeatClockTime - - ---- - -### heartbeatPing - - ---- - -### identified - - ---- - -### resumeGatewayUrl - - ---- - -### heartbeatAck - - ---- - -### activeConnections - - ---- - -### onEvent - - ---- - -### onIdentified - - ---- - -### shardId - - ---- - ### udpActive diff --git a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx index fbc090a..b5cb095 100644 --- a/src/content/docs/classes/Network/DiscordVoiceConnection.mdx +++ b/src/content/docs/classes/Network/DiscordVoiceConnection.mdx @@ -99,12 +99,12 @@ This class is internal and should not be used directly by developers. Instead, u ### voiceServerUpdate - + --- ### voiceStateUpdate - + --- ### onEvent diff --git a/src/content/docs/classes/Network/WebsocketBuffer.mdx b/src/content/docs/classes/Network/WebsocketBuffer.mdx index 289b9ef..1e66a4a 100644 --- a/src/content/docs/classes/Network/WebsocketBuffer.mdx +++ b/src/content/docs/classes/Network/WebsocketBuffer.mdx @@ -29,11 +29,6 @@ This class is internal and should not be used directly by developers. Instead, u ### data - ---- - -### data - --- @@ -54,7 +49,12 @@ This class is internal and should not be used directly by developers. Instead, u ### metadata - + +--- + +### data + + --- diff --git a/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx b/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx index 5c89795..ae277c3 100644 --- a/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx +++ b/src/content/docs/classes/Objects/BaseGuildTextChannel.mdx @@ -23,16 +23,6 @@ A base guild text channel, where any/all text channels extend from. ## Properties -### lastPinTimestamp - - ---- - -### lastMessageId - - ---- - ### guildId @@ -63,6 +53,16 @@ A base guild text channel, where any/all text channels extend from. --- +### lastPinTimestamp + + +--- + +### lastMessageId + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/BaseGuildThread.mdx b/src/content/docs/classes/Objects/BaseGuildThread.mdx index 8ea5d90..d5a6089 100644 --- a/src/content/docs/classes/Objects/BaseGuildThread.mdx +++ b/src/content/docs/classes/Objects/BaseGuildThread.mdx @@ -45,12 +45,12 @@ A base discord Thread channel, all discord threads extend from. ### threadMetadata - + --- ### availableTags - + --- ### appliedTags @@ -63,20 +63,6 @@ A base discord Thread channel, all discord threads extend from. --- -### lastPinTimestamp - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) -### lastMessageId - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) ### guildId @@ -118,6 +104,20 @@ A base discord Thread channel, all discord threads extend from. --- +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastPinTimestamp + + +--- + + +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastMessageId + + +--- + + > This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordApplication.mdx b/src/content/docs/classes/Objects/DiscordApplication.mdx index a146dbb..dcb3f03 100644 --- a/src/content/docs/classes/Objects/DiscordApplication.mdx +++ b/src/content/docs/classes/Objects/DiscordApplication.mdx @@ -28,32 +28,6 @@ The `DiscordApplication` class provides methods to interact with Discord applica --- -### recipients - - ---- - -### id - - -### flags - - -### id - - ---- - -### flags - - ---- - -### id - - ---- - ### guildId @@ -84,6 +58,32 @@ The `DiscordApplication` class provides methods to interact with Discord applica --- +### id + + +--- + +### recipients + + +--- + +### id + + +### flags + + +### id + + +--- + +### flags + + +--- + [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx index 7974cee..5a14a3b 100644 --- a/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx +++ b/src/content/docs/classes/Objects/DiscordAutomoderationRule.mdx @@ -65,12 +65,12 @@ The `DiscordAutomoderationRule` class provides methods to interact with Discord ### triggerMetadata - + --- ### actions - + --- diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx index 757bf57..47f7b5b 100644 --- a/src/content/docs/classes/Objects/DiscordGuild.mdx +++ b/src/content/docs/classes/Objects/DiscordGuild.mdx @@ -183,7 +183,7 @@ Gets the vanity url for this guild. Gets the guild welcome screen for this guild. ### getGuildWidgetImageAsync -> +> Gets the binary PNG image for a server widget ### modifyGuildWelcomeScreenAsync diff --git a/src/content/docs/classes/Objects/DiscordInvite.mdx b/src/content/docs/classes/Objects/DiscordInvite.mdx index 68b34c6..3292598 100644 --- a/src/content/docs/classes/Objects/DiscordInvite.mdx +++ b/src/content/docs/classes/Objects/DiscordInvite.mdx @@ -35,7 +35,7 @@ DiscordInvite represents an invite link to a Discord server, providing methods t ### guild - + --- ### inviter @@ -55,7 +55,7 @@ DiscordInvite represents an invite link to a Discord server, providing methods t ### targetApplication - + --- diff --git a/src/content/docs/classes/Objects/DiscordMessage.mdx b/src/content/docs/classes/Objects/DiscordMessage.mdx index 0cb0e19..b3d8cfa 100644 --- a/src/content/docs/classes/Objects/DiscordMessage.mdx +++ b/src/content/docs/classes/Objects/DiscordMessage.mdx @@ -50,7 +50,7 @@ DiscordMessage represents a message in a Discord channel, providing methods to r ### author - + --- ### content @@ -95,7 +95,7 @@ DiscordMessage represents a message in a Discord channel, providing methods to r ### member - + --- diff --git a/src/content/docs/classes/Objects/GuildAnnouncementChannel.mdx b/src/content/docs/classes/Objects/GuildAnnouncementChannel.mdx index 45fcff5..60cf6b6 100644 --- a/src/content/docs/classes/Objects/GuildAnnouncementChannel.mdx +++ b/src/content/docs/classes/Objects/GuildAnnouncementChannel.mdx @@ -23,20 +23,6 @@ Represents the implementation of a Discord Announcement channel. ## Properties -### lastPinTimestamp - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) -### lastMessageId - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) ### guildId @@ -78,6 +64,20 @@ Represents the implementation of a Discord Announcement channel. --- +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastPinTimestamp + + +--- + + +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastMessageId + + +--- + + > This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildAnnouncementThreadChannel.mdx b/src/content/docs/classes/Objects/GuildAnnouncementThreadChannel.mdx index 147c392..c355097 100644 --- a/src/content/docs/classes/Objects/GuildAnnouncementThreadChannel.mdx +++ b/src/content/docs/classes/Objects/GuildAnnouncementThreadChannel.mdx @@ -53,14 +53,14 @@ Represents the implementation of a Discord Announcement thread channel. > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### threadMetadata - + --- > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### availableTags - + --- diff --git a/src/content/docs/classes/Objects/GuildDirectoryChannel.mdx b/src/content/docs/classes/Objects/GuildDirectoryChannel.mdx index b36907a..50ae8b4 100644 --- a/src/content/docs/classes/Objects/GuildDirectoryChannel.mdx +++ b/src/content/docs/classes/Objects/GuildDirectoryChannel.mdx @@ -23,20 +23,6 @@ Represents the implementation of a Discord Directory channel. ## Properties -### lastPinTimestamp - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) -### lastMessageId - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) ### guildId @@ -78,6 +64,20 @@ Represents the implementation of a Discord Directory channel. --- +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastPinTimestamp + + +--- + + +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastMessageId + + +--- + + > This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) [//]: # (----- DOCUMENT METHODS ----- ) diff --git a/src/content/docs/classes/Objects/GuildPrivateThreadChannel.mdx b/src/content/docs/classes/Objects/GuildPrivateThreadChannel.mdx index 74504f6..b47bea1 100644 --- a/src/content/docs/classes/Objects/GuildPrivateThreadChannel.mdx +++ b/src/content/docs/classes/Objects/GuildPrivateThreadChannel.mdx @@ -53,14 +53,14 @@ Represents the implementation of a Discord Private Thread channel. > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### threadMetadata - + --- > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### availableTags - + --- diff --git a/src/content/docs/classes/Objects/GuildPublicThreadChannel.mdx b/src/content/docs/classes/Objects/GuildPublicThreadChannel.mdx index b45dfb5..fb5e181 100644 --- a/src/content/docs/classes/Objects/GuildPublicThreadChannel.mdx +++ b/src/content/docs/classes/Objects/GuildPublicThreadChannel.mdx @@ -53,14 +53,14 @@ Represents the implementation of a Discord Public Thread channel. > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### threadMetadata - + --- > This property was inherited from [Objects.BaseGuildThread](Objects.BaseGuildThread) ### availableTags - + --- diff --git a/src/content/docs/classes/Objects/GuildTextChannel.mdx b/src/content/docs/classes/Objects/GuildTextChannel.mdx index 5cf7d0e..bc1d466 100644 --- a/src/content/docs/classes/Objects/GuildTextChannel.mdx +++ b/src/content/docs/classes/Objects/GuildTextChannel.mdx @@ -23,20 +23,6 @@ Represents the implementation of a Discord Text channel. ## Properties -### lastPinTimestamp - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) -### lastMessageId - - ---- - - -> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) ### guildId @@ -78,6 +64,20 @@ Represents the implementation of a Discord Text channel. --- +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastPinTimestamp + + +--- + + +> This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) +### lastMessageId + + +--- + + > This property was inherited from [Objects.BaseGuildTextChannel](Objects.BaseGuildTextChannel) [//]: # (----- DOCUMENT METHODS ----- )