From 14c9aa36ea21e14c61930548d7c472d1529d380c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 11 Jun 2024 19:21:15 +0000 Subject: [PATCH] docs: update refs for https://github.com/DiscordLuau/discord-luau/commit/6510ce25c6899b8ccf7fd8a68ff0b8b08721a9ca --- discord-luau | 2 +- .../docs/classes/Builders/GuildBuilder.mdx | 8 ++ .../classes/Builders/OnboardingBuilder.mdx | 79 +++++++++++++++++ .../Builders/OnboardingPromptBuilder.mdx | 86 +++++++++++++++++++ .../OnboardingPromptOptionBuilder.mdx | 67 +++++++++++++++ .../classes/Builders/WelcomeScreenBuilder.mdx | 59 +++++++++++++ src/content/docs/classes/DiscordLuau.mdx | 12 +++ .../docs/classes/Objects/DiscordGuild.mdx | 80 +++++++++++++++++ .../docs/classes/Objects/DiscordGuildBan.mdx | 43 ++++++++++ .../docs/classes/Objects/DiscordGuildRole.mdx | 12 +++ .../classes/Objects/DiscordIntegration.mdx | 42 +++++++++ .../docs/classes/Objects/GuildOnboarding.mdx | 43 ++++++++++ .../classes/Objects/GuildOnboardingPrompt.mdx | 52 +++++++++++ .../classes/Objects/GuildWelcomeScreen.mdx | 43 ++++++++++ .../docs/classes/Objects/GuildWidget.mdx | 43 ++++++++++ 15 files changed, 670 insertions(+), 1 deletion(-) create mode 100644 src/content/docs/classes/Builders/OnboardingBuilder.mdx create mode 100644 src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx create mode 100644 src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx create mode 100644 src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx create mode 100644 src/content/docs/classes/Objects/DiscordGuildBan.mdx create mode 100644 src/content/docs/classes/Objects/DiscordIntegration.mdx create mode 100644 src/content/docs/classes/Objects/GuildOnboarding.mdx create mode 100644 src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx create mode 100644 src/content/docs/classes/Objects/GuildWelcomeScreen.mdx create mode 100644 src/content/docs/classes/Objects/GuildWidget.mdx diff --git a/discord-luau b/discord-luau index e89e4bf..6510ce2 160000 --- a/discord-luau +++ b/discord-luau @@ -1 +1 @@ -Subproject commit e89e4bfa1835624d855ff6c5dd665bd97bfd1acb +Subproject commit 6510ce25c6899b8ccf7fd8a68ff0b8b08721a9ca diff --git a/src/content/docs/classes/Builders/GuildBuilder.mdx b/src/content/docs/classes/Builders/GuildBuilder.mdx index d2b8e92..ff7e8bc 100644 --- a/src/content/docs/classes/Builders/GuildBuilder.mdx +++ b/src/content/docs/classes/Builders/GuildBuilder.mdx @@ -20,6 +20,14 @@ import LuaProperty from '$/components/LuaProperty.astro'; ## Properties +### MFALevel + + +--- +An enumeration of MFA levels. + +- None: 0 +- Elevated: 1 ### VerificationLevel diff --git a/src/content/docs/classes/Builders/OnboardingBuilder.mdx b/src/content/docs/classes/Builders/OnboardingBuilder.mdx new file mode 100644 index 0000000..4c77695 --- /dev/null +++ b/src/content/docs/classes/Builders/OnboardingBuilder.mdx @@ -0,0 +1,79 @@ +--- +title: OnboardingBuilder +description: DiscordLuau docs for OnboardingBuilder. +--- +[//]: # (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 ----- ) + +OnboardingBuilder allows you to build onboarding for discord guilds. + +Usage: +```lua +local DiscordLuau = require("../Submodules/DiscordLuau") + +local OnboardingBuilder = DiscordLuau.OnboardingBuilder.new() + :setMode(DiscordLuau.OnboardingBuilder.Mode.Default) + :setEnabled(true) + :addChannelId("1048686561685946489") +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### Mode + + +--- +An enumeration of onboarding modes + +- Default: 0 +- Advanced: 1 + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### toPayloadObject + +> +Converts the message to a JSON object that can be sent to the Discord API. +### setMode + +> +Sets the mode of the Guild onbaording object +### setEnabled + +> +Sets if the guild onboarding is enabled or not +### addChannelId + +> +Channel IDs that members get opted into automatically +### addOnboardingPrompt + +> +Channel IDs that members get opted into automatically +### toPayloadObject + +> +Converts the message to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of OnboardingBuilder. + diff --git a/src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx b/src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx new file mode 100644 index 0000000..55189d0 --- /dev/null +++ b/src/content/docs/classes/Builders/OnboardingPromptBuilder.mdx @@ -0,0 +1,86 @@ +--- +title: OnboardingPromptBuilder +description: DiscordLuau docs for OnboardingPromptBuilder. +--- +[//]: # (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 ----- ) + +OnboardingPromptBuilder allows you to build onboarding for discord guilds. + +Usage: +```lua +local DiscordLuau = require("../Submodules/DiscordLuau") + +local OnboardingPromptBuilder = DiscordLuau.OnboardingPromptBuilder.new() + :setType(DiscordLuau.OnboardingPromptBuilder.Type.Dropdown) + :addOption( + DiscordLuau.OnboardingPromptOptionBuilder.new() + :setTitle("option-name") + :setDescription("Option Description!") + ) +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### Type + + +--- +An enumeration of prompt types + +- MultipleChoice: 0 +- Dropdown: 1 + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setType + +> +Set the type of the Onboarding Prompt builder +### addOption + +> +Adds an option to the Onboarding prompt builder. +### setTitle + +> +Sets the title of the onboarding prompt builder +### setSingleSelection + +> +Indicates whether users are limited to selecting one option for the prompt +### setRequired + +> +Indicates whether the prompt is required before a user completes the onboarding flow +### setIsOnboarding + +> +Indicates whether the prompt is present in the onboarding flow. If false, the prompt will only appear in the Channels & Roles tab +### toPayloadObject + +> +Converts the message to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of OnboardingPromptBuilder. + diff --git a/src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx b/src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx new file mode 100644 index 0000000..4976fb1 --- /dev/null +++ b/src/content/docs/classes/Builders/OnboardingPromptOptionBuilder.mdx @@ -0,0 +1,67 @@ +--- +title: OnboardingPromptOptionBuilder +description: DiscordLuau docs for OnboardingPromptOptionBuilder. +--- +[//]: # (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 ----- ) + +OnboardingPromptOptionBuilder allows you to build onboarding for discord guilds. + +Usage: +```lua +local DiscordLuau = require("../Submodules/DiscordLuau") + +local OnboardingPromptOptionBuilder = DiscordLuau.OnboardingPromptOptionBuilder.new() + :setTitle("option-name") + :setDescription("Option Description!") +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The OnboardingPromptOptionBuilder instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### setTitle + +> +Sets the title of the Prompt Option builder +### setDescription + +> +Sets the description of the Prompt Option builder +### addChannelId + +> +Add a channel id to the prompt option builder +### addRoleId + +> +Add a role id to the prompt option builder +### setEmoji + +> +Sets the emoji of the Onboarding Prompt Option Builder + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of OnboardingPromptOptionBuilder with the specified intents. + diff --git a/src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx b/src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx new file mode 100644 index 0000000..2d11a1a --- /dev/null +++ b/src/content/docs/classes/Builders/WelcomeScreenBuilder.mdx @@ -0,0 +1,59 @@ +--- +title: WelcomeScreenBuilder +description: DiscordLuau docs for WelcomeScreenBuilder. +--- +[//]: # (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 ----- ) + +WelcomeScreenBuilder allows you to build welcome screens for discord guilds. + +Usage: +```lua +local DiscordLuau = require("../Submodules/DiscordLuau") + +local WelcomeScreenBuilder = DiscordLuau.WelcomeScreenBuilder.new() + :addChannel("1048686561685946489", "Super cool discord channel") + :setDescription("Yeah, a super awesome dsicord channel!") +``` + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The WelcomeScreenBuilder instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### addChannel + +> +Adds a channel object to the guilds Welcome Screen +### setDescription + +> +Adds a channel object to the guilds Welcome Screen +### toPayloadObject + +> +Converts the message to a JSON object that can be sent to the Discord API. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of WelcomeScreenBuilder. + diff --git a/src/content/docs/classes/DiscordLuau.mdx b/src/content/docs/classes/DiscordLuau.mdx index 893b4ed..2120d58 100644 --- a/src/content/docs/classes/DiscordLuau.mdx +++ b/src/content/docs/classes/DiscordLuau.mdx @@ -32,6 +32,18 @@ A Discord API wrapper written in Luau, expected to run under the Lune runtime. ### TextInputBuilder +### OnboardingBuilder + + +### OnboardingPromptBuilder + + +### OnboardingPromptOptionBuilder + + +### WelcomeScreenBuilder + + ### MessageBuilder diff --git a/src/content/docs/classes/Objects/DiscordGuild.mdx b/src/content/docs/classes/Objects/DiscordGuild.mdx index 1a690c0..f4928d3 100644 --- a/src/content/docs/classes/Objects/DiscordGuild.mdx +++ b/src/content/docs/classes/Objects/DiscordGuild.mdx @@ -114,6 +114,86 @@ Fetches all active guild threads. > 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 new file mode 100644 index 0000000..f8986d6 --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordGuildBan.mdx @@ -0,0 +1,43 @@ +--- +title: DiscordGuildBan +description: DiscordLuau docs for DiscordGuildBan. +--- +[//]: # (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 `DiscordGuildBan` class provides a way for developers to interact with guild bans. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the DiscordGuildBan. Default is "DiscordGuildBan". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The DiscordGuildBan instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new DiscordGuildBan instance. + diff --git a/src/content/docs/classes/Objects/DiscordGuildRole.mdx b/src/content/docs/classes/Objects/DiscordGuildRole.mdx index 18dba0c..17b08b3 100644 --- a/src/content/docs/classes/Objects/DiscordGuildRole.mdx +++ b/src/content/docs/classes/Objects/DiscordGuildRole.mdx @@ -36,6 +36,18 @@ The DiscordGuildRole instance has no set methods! ## Functions +### updatePositionAsync + +> +Creates a new DiscordGuildRole instance. +### modifyAsync + +> +Allows the developer to update/modify a discord role +### deleteAsync + +> +Deletes the Role from the discord guild asynchronously. ### new > diff --git a/src/content/docs/classes/Objects/DiscordIntegration.mdx b/src/content/docs/classes/Objects/DiscordIntegration.mdx new file mode 100644 index 0000000..1b74c92 --- /dev/null +++ b/src/content/docs/classes/Objects/DiscordIntegration.mdx @@ -0,0 +1,42 @@ +--- +title: DiscordIntegration +description: DiscordLuau docs for DiscordIntegration. +--- +[//]: # (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 ----- ) + +DiscordIntegration represents a guild integration. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +The DiscordIntegration instance has no set properties! + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +### deleteAsync + +> +Deletes the invite asynchronously. + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new instance of DiscordIntegration. + diff --git a/src/content/docs/classes/Objects/GuildOnboarding.mdx b/src/content/docs/classes/Objects/GuildOnboarding.mdx new file mode 100644 index 0000000..cf2969e --- /dev/null +++ b/src/content/docs/classes/Objects/GuildOnboarding.mdx @@ -0,0 +1,43 @@ +--- +title: GuildOnboarding +description: DiscordLuau docs for GuildOnboarding. +--- +[//]: # (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 `GuildOnboarding` class provides a way for developers to interact with a Guild Onboarding. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the GuildOnboarding. Default is "GuildOnboarding". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildOnboarding instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new GuildOnboarding instance. + diff --git a/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx b/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx new file mode 100644 index 0000000..7ab37a3 --- /dev/null +++ b/src/content/docs/classes/Objects/GuildOnboardingPrompt.mdx @@ -0,0 +1,52 @@ +--- +title: GuildOnboardingPrompt +description: DiscordLuau docs for GuildOnboardingPrompt. +--- +[//]: # (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 `GuildOnboardingPrompt` class provides a way for developers to interact with a guild onboarding prompt. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the GuildOnboardingPrompt. Default is "GuildOnboardingPrompt". +### type + + +--- +The type of the GuildOnboardingPrompt. Default is "GuildOnboardingPrompt". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildOnboardingPrompt instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new GuildOnboardingPrompt instance. +### new + +> +Creates a new GuildOnboardingPrompt instance. + diff --git a/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx b/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx new file mode 100644 index 0000000..e8a7c2f --- /dev/null +++ b/src/content/docs/classes/Objects/GuildWelcomeScreen.mdx @@ -0,0 +1,43 @@ +--- +title: GuildWelcomeScreen +description: DiscordLuau docs for GuildWelcomeScreen. +--- +[//]: # (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 `GuildWelcomeScreen` class provides a way for developers to interact with a Welcome Screen. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the GuildWelcomeScreen. Default is "GuildWelcomeScreen". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildWelcomeScreen instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new GuildWelcomeScreen instance. + diff --git a/src/content/docs/classes/Objects/GuildWidget.mdx b/src/content/docs/classes/Objects/GuildWidget.mdx new file mode 100644 index 0000000..cc25216 --- /dev/null +++ b/src/content/docs/classes/Objects/GuildWidget.mdx @@ -0,0 +1,43 @@ +--- +title: GuildWidget +description: DiscordLuau docs for GuildWidget. +--- +[//]: # (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 `GuildWidget` class provides a way for developers to interact with a Widget. + +[//]: # (----- DOCUMENT PROPERTIES ----- ) + +## Properties + +### type + + +--- +The type of the GuildWidget. Default is "GuildWidget". + +[//]: # (----- DOCUMENT METHODS ----- ) + +## Methods + +The GuildWidget instance has no set methods! + +[//]: # (----- DOCUMENT FUNCTIONS ----- ) + +## Functions + +### new + +> +Creates a new GuildWidget instance. +