WidgetSettings

Implementation of discords WidgetSettings object as a Luau builder.

https://discord.com/developers/docs/resources/guild#guild-widget-settings-object

Summary

Properties

WidgetSettings.enabled :: boolean?WidgetSettings.channelId :: string?

Methods

WidgetSettings:setEnabled(enabled: boolean) → WidgetSettingsWidgetSettings:setChannelId(channelId: string) → WidgetSettingsWidgetSettings:build() → JSON

Functions

WidgetSettings.new(resource: { enabled: boolean?, channelId: string?, }?) → WidgetSettings

Properties

enabled

WidgetSettings.enabled  :: boolean?

---

Whether the widget is enabled for the guild.

channelId

WidgetSettings.channelId  :: string?

---

The channel id that the widget will generate an invite to.

Methods

setEnabled

WidgetSettings : setEnabled ( enabled )  -> WidgetSettings

Set whether the widget is enabled

Parameters

enabled: boolean

Returns

WidgetSettings

setChannelId

WidgetSettings : setChannelId ( channelId )  -> WidgetSettings

Set the widget channel id

Parameters

channelId: string

Returns

WidgetSettings

build

WidgetSettings : build ( )  -> JSON

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

Returns

JSON

Functions

new

WidgetSettings . new ( resource )  -> WidgetSettings

Responsible for creating a new WidgetSettings.

local settings = WidgetSettings.new({
  enabled = true,
  channelId = "123456789"
})

Parameters

resource: { enabled: boolean?, channelId: string?, }

Returns

WidgetSettings