Skip to main content
Version: Next

ImageWidget

@devvit/public-api v0.12.14-dev

Class: ImageWidget

Extends​

Constructors​

new ImageWidget()​

new ImageWidget(widgetData, subredditName, metadata): ImageWidget

Parameters​

widgetData​

GetWidgetsResponse_WidgetItem

subredditName​

string

metadata​

undefined | Metadata

Returns​

ImageWidget

Overrides​

Widget.constructor

Accessors​

id​

Get Signature​

get id(): string

Returns​

string

Inherited from​

Widget.id

images​

Get Signature​

get images(): WidgetImage[]

Returns​

WidgetImage[]

name​

Get Signature​

get name(): string

Returns​

string

Inherited from​

Widget.name

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<ImageWidget, "images">

Returns​

Pick<Widget, "subredditName" | "id" | "name"> & Pick<ImageWidget, "images">

Overrides​

Widget.toJSON