Skip to main content
Version: 0.11

Class: ButtonWidget

models.ButtonWidget

Hierarchy​

Table of contents​

Constructors​

Accessors​

Methods​

Constructors​

constructor​

• new ButtonWidget(widgetData, subredditName, metadata): ButtonWidget

Parameters​

NameType
widgetDataGetWidgetsResponse_WidgetItem
subredditNamestring
metadataundefined | Metadata

Returns​

ButtonWidget

Overrides​

Widget.constructor

Accessors​

buttons​

• get buttons(): WidgetButton[]

Returns​

WidgetButton[]

description​

• get description(): string

Returns​

string

id​

• get id(): string

Returns​

string

Inherited from​

Widget.id

name​

• get name(): string

Returns​

string

Inherited from​

Widget.name

styles​

• get styles(): WidgetStyles

Returns​

WidgetStyles

subredditName​

• get subredditName(): string

Returns​

string

Inherited from​

Widget.subredditName

Methods​

delete​

▸ delete(): Promise<void>

Returns​

Promise<void>

Inherited from​

Widget.delete

toJSON​

▸ toJSON(): Pick<Widget, "subredditName" | "id" | "name"> & Pick<ButtonWidget, "description" | "styles" | "buttons">

Returns​

Pick<Widget, "subredditName" | "id" | "name"> & Pick<ButtonWidget, "description" | "styles" | "buttons">

Overrides​

Widget.toJSON