LogoAntiRaid

@discord-types/builders/guild/widgetSettings

API reference for @discord-types/builders/guild/widgetSettings

@discord-types/builders/guild/widgetSettings

Types

WidgetSettings

Raw Type
type WidgetSettings = WidgetSettings.Prototype, & {
	enabled: boolean?,

	channelId: apiTypes.Snowflake?
}

Intersection with variants:

Variant 2
PropTypeDescription
enabled?
-
channelId?
-

JSON

Raw Type
type JSON = WidgetSettings.Prototype.build(nil :: any),

Functions

WidgetSettings.Prototype.setEnabled

[[ Set whether the widget is enabled ]]

Function Signature
--[[
	Set whether the widget is enabled
]]
function WidgetSettings.Prototype.setEnabled(self: WidgetSettings, enabled: boolean) -> WidgetSettings end

Arguments

enabled

boolean

Returns

ret1

WidgetSettings

WidgetSettings.Prototype.setChannelId

[[ Set the widget channel id ]]

Function Signature
--[[
	Set the widget channel id
]]
function WidgetSettings.Prototype.setChannelId(self: WidgetSettings, channelId: string) -> WidgetSettings end

Arguments

channelId

string

Returns

ret1

WidgetSettings

WidgetSettings.Prototype.build

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

Function Signature
--[[
	Responsible for building the WidgetSettingsObject JSON that can be parsed by the Discord API.
]]
function WidgetSettings.Prototype.build(self: WidgetSettings) -> JSON end

Returns

ret1

JSON

WidgetSettings.Interface.new

[[ Responsible for creating a new WidgetSettings.

```lua

``` ]]

Function Signature
--[[
	Responsible for creating a new WidgetSettings.

	\`\`\`lua
	
	\`\`\`
]]
function WidgetSettings.Interface.new(resource: {
		enabled: boolean?,

		channelId: string?
	}?) -> WidgetSettings end

Arguments

resource

This field is optional and may not be specified

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

Returns

ret1

WidgetSettings

Last updated on