Skip to main content
Version: Next

ButtonWidget

@devvit/public-api v0.12.14-dev

Class: ButtonWidget

Extends​

Constructors​

new ButtonWidget()​

new ButtonWidget(widgetData, subredditName, metadata): ButtonWidget

Parameters​

widgetData​

GetWidgetsResponse_WidgetItem

subredditName​

string

metadata​

undefined | Metadata

Returns​

ButtonWidget

Overrides​

Widget.constructor

Accessors​

buttons​

Get Signature​

get buttons(): WidgetButton[]

Returns​

WidgetButton[]

description​

Get Signature​

get description(): string

Returns​

string

id​

Get Signature​

get id(): string

Returns​

string

Inherited from​

Widget.id

name​

Get Signature​

get name(): string

Returns​

string

Inherited from​

Widget.name

styles​

Get Signature​

get styles(): WidgetStyles

Returns​

WidgetStyles

subredditName​

Get Signature​

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