Skip to content

Widget

Implementation of the Discord Widget class in Luau

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

Properties

id

Widget.id  :: string

The unique identifier of this widget

name

Widget.name  :: string

The name of the widget

instantInvite

Widget.instantInvite  :: string?

The instant invite URL for this widget, if one exists

channels

Widget.channels  :: { Classes.Channel }

Array of channels that are shown in the widget

members

Widget.members  :: { Classes.User }

Array of users that are shown in the widget

Methods

The Widget instance has no set methods!

Functions

sync

Widget . sync (

     self: Widget
     widgetData: apiTypes.GuildWidgetObject
)  -> ()

Responsible for syncing data to this widget object. This is typically called by the API when this object is created or updated.

new

Widget . new (

     state: state.State
     widgetData: apiTypes.GuildWidgetObject
)  -> ()

Responsible for constructing this class.