Guild

Implementation of Discord’s Guild object as a Luau builder.

See Discord’s documentation for more information about the allow and deny fields:

https://discord.com/developers/docs/resources/guild

Summary

Properties

Guild.name :: string?Guild.verificationLevel :: Classes.VerificationLevel Guild.defaultMessageNotifications :: Classes.DefaultMessageNotification Guild.explicitContentFilter :: Classes.ExplicitContentFilterLevel Guild.afkChannelId :: string?Guild.afkTimeout :: number?Guild.icon :: string?Guild.ownerId :: string?Guild.splash :: string?Guild.discoverySplash :: string?Guild.banner :: string?Guild.systemChannelId :: string?Guild.systemChannelFlags :: number?Guild.rulesChannelId :: string?Guild.publicUpdatesChannelId :: string?Guild.preferredLocale :: Classes.LanguageLocales?Guild.features :: { Builders.GuildFeature }Guild.description :: string?Guild.premiumProgressBarEnabled :: boolean?Guild.safetyAlertsChannelId :: string?

Methods

Functions

Guild.new(resource: { name: string?, verificationLevel: apiTypes.VerificationLevel?, defaultMessageNotifications: apiTypes.DefaultMessageNotification?, explicitContentFilter: apiTypes.ExplicitContentFilterLevel?, afkChannelId: apiTypes.Snowflake?, afkTimeout: number?, icon: string?, ownerId: apiTypes.Snowflake?, splash: string?, discoverySplash: string?, banner: string?, systemChannelId: apiTypes.Snowflake?, systemChannelFlags: number?, rulesChannelId: apiTypes.Snowflake?, publicUpdatesChannelId: apiTypes.Snowflake?, preferredLocale: apiTypes.LanguageLocales?, features: { apiTypes.GuildFeature }?, description: string?, premiumProgressBarEnabled: boolean?, safetyAlertsChannelId: apiTypes.Snowflake?, }?) → Guild

Properties

name

Guild.name :: string?

The name of the guild.

verificationLevel

Guild.verificationLevel :: VerificationLevel

Verification level setting for the guild.

defaultMessageNotifications

Guild.defaultMessageNotifications :: DefaultMessageNotification

Default message notification level.

explicitContentFilter

Guild.explicitContentFilter :: ExplicitContentFilterLevel

Explicit content filter level setting.

afkChannelId

Guild.afkChannelId :: string?

ID of the AFK voice channel.

afkTimeout

Guild.afkTimeout :: number?

AFK timeout duration in seconds.

icon

Guild.icon :: string?

Base64 encoded icon for the guild.

ownerId

Guild.ownerId :: string?

User ID of the owner of the guild.

splash

Guild.splash :: string?

Base64 splash image for the guild.

discoverySplash

Guild.discoverySplash :: string?

Base64 discovery splash image for the guild.

Guild.banner :: string?

Base64 banner image for the guild.

systemChannelId

Guild.systemChannelId :: string?

ID of the system messages channel.

systemChannelFlags

Guild.systemChannelFlags :: number?

Flags for the system channel.

rulesChannelId

Guild.rulesChannelId :: string?

ID of the rules channel.

publicUpdatesChannelId

Guild.publicUpdatesChannelId :: string?

ID of the public updates channel.

preferredLocale

Guild.preferredLocale :: LanguageLocales?

Preferred language/locale for the guild.

features

Guild.features :: GuildFeature }

List of enabled guild features.

description

Guild.description :: string?

Description of the guild.

premiumProgressBarEnabled

Guild.premiumProgressBarEnabled :: boolean?

Whether boost progress bar is enabled.

safetyAlertsChannelId

Guild.safetyAlertsChannelId :: string?

ID of the safety alerts channel.

Methods

setName

Guild : setName ( name ) -> Guild

Set the name for this guild.

Parameters

name: string

Returns

Guild

setVerificationLevel

Guild : setVerificationLevel ( verificationLevel ) -> Guild

Set the explicit verification level for this guild.

Parameters

verificationLevel: VerificationLevel

Returns

Guild

setDefaultMessageNotifications

Guild : setDefaultMessageNotifications ( defaultMessageNotifications ) -> Guild

Set the explicit default message notifications for this guild.

Parameters

defaultMessageNotifications: DefaultMessageNotification

Returns

Guild

setExplicitContentFilter

Guild : setExplicitContentFilter ( explicitContentFilter ) -> Guild

Set the explicit content filter level for this guild.

Parameters

explicitContentFilter: ExplicitContentFilterLevel

Returns

Guild

setAfkChannelId

Guild : setAfkChannelId ( afkChannelId ) -> Guild

Set the id for the AFK channel.

Parameters

afkChannelId: Snowflake

Returns

Guild

setAfkTimeout

Guild : setAfkTimeout ( afkTimeout ) -> Guild

Set the AFK timeout in seconds. Can be one of: 60, 300, 900, 1800, 3600.

Parameters

afkTimeout: number

Returns

Guild

setIcon

Guild : setIcon ( source ) -> Guild

Set the base64 1024x1024 PNG/JPEG/GIF image for the guild icon.

Parameters

source: string

Returns

Guild

setOwnerId

Guild : setOwnerId ( ownerId ) -> Guild

Set the user ID to transfer guild ownership to (must be owner).

Parameters

ownerId: Snowflake

Returns

Guild

setSplash

Guild : setSplash ( source ) -> Guild

Set the base64 16:9 PNG/JPEG image for the guild splash.

Parameters

source: string

Returns

Guild

setDiscoverySplash

Guild : setDiscoverySplash ( source ) -> Guild

Set the base64 16:9 PNG/JPEG image for the discovery splash of the guild.

Parameters

source: string

Returns

Guild

setBanner

Guild : setBanner ( source ) -> Guild

Set the base64 16:9 PNG/JPEG/GIF image for the guild banner.

Parameters

source: string

Returns

Guild

setSystemChannelId

Guild : setSystemChannelId ( systemChannelId ) -> Guild

Set the ID of the system channel.

Parameters

systemChannelId: Snowflake

Returns

Guild

setSystemChannelFlags

Guild : setSystemChannelFlags ( systemChannelFlags ) -> Guild

Set the system channel flags.

Parameters

systemChannelFlags: number

Returns

Guild

setRulesChannelId

Guild : setRulesChannelId ( rulesChannelId ) -> Guild

Set the ID of the rules channel.

Parameters

rulesChannelId: Snowflake

Returns

Guild

setPublicUpdatesChannelId

Guild : setPublicUpdatesChannelId ( publicUpdatesChannelId ) -> Guild

Set the ID of the public updates channel.

Parameters

publicUpdatesChannelId: Snowflake

Returns

Guild

setPreferredLocale

Guild : setPreferredLocale ( preferredLocale ) -> Guild

Set the preferred locale of the guild.

Parameters

preferredLocale: LanguageLocales

Returns

Guild

addFeature

Guild : addFeature ( feature ) -> Guild

Enable a specific guild feature.

Parameters

feature: GuildFeature

Returns

Guild

setDescription

Guild : setDescription ( description ) -> Guild

Set the description for the guild.

Parameters

description: string

Returns

Guild

setPremiumProgressBarEnabled

Guild : setPremiumProgressBarEnabled ( premiumProgressBarEnabled ) -> Guild

Set whether the guild’s boost progress bar should be enabled.

Parameters

premiumProgressBarEnabled: boolean

Returns

Guild

setSafetyAlertsChannelId

Guild : setSafetyAlertsChannelId ( safetyAlertsChannelId ) -> Guild

Set the ID of the safety alerts channel.

Parameters

safetyAlertsChannelId: Snowflake

Returns

Guild

build

Guild : build ( ) -> JSON

Responsible for building the Guild JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

Guild . new ( resource ) -> Guild

Construct a new Guild object.

Parameters

resource: {
name: string?,
verificationLevel: apiTypes.VerificationLevel?,
defaultMessageNotifications: apiTypes.DefaultMessageNotification?,
explicitContentFilter: apiTypes.ExplicitContentFilterLevel?,
afkChannelId: apiTypes.Snowflake?,
afkTimeout: number?,
icon: string?,
ownerId: apiTypes.Snowflake?,
splash: string?,
discoverySplash: string?,
banner: string?,
systemChannelId: apiTypes.Snowflake?,
systemChannelFlags: number?,
rulesChannelId: apiTypes.Snowflake?,
publicUpdatesChannelId: apiTypes.Snowflake?,
preferredLocale: apiTypes.LanguageLocales?,
features: { apiTypes.GuildFeature,
}

Returns

Guild