Skip to main content
Version: 0.11

Class: CustomWidget

models.CustomWidget

Hierarchy​

Table of contents​

Constructors​

Accessors​

Methods​

Constructors​

constructor​

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

Parameters​

NameType
widgetDataGetWidgetsResponse_WidgetItem
subredditNamestring
metadataundefined | Metadata

Returns​

CustomWidget

Overrides​

Widget.constructor

Accessors​

css​

• get css(): string

Returns​

string

height​

• get height(): number

Returns​

number

id​

• get id(): string

Returns​

string

Inherited from​

Widget.id

images​

• get images(): WidgetImage[]

Returns​

WidgetImage[]

name​

• get name(): string

Returns​

string

Inherited from​

Widget.name

stylesheetUrl​

• get stylesheetUrl(): string

Returns​

string

subredditName​

• get subredditName(): string

Returns​

string

Inherited from​

Widget.subredditName

text​

• get text(): string

Returns​

string

Methods​

delete​

▸ delete(): Promise<void>

Returns​

Promise<void>

Inherited from​

Widget.delete

toJSON​

▸ toJSON(): Pick<Widget, "subredditName" | "id" | "name"> & Pick<CustomWidget, "text" | "height" | "images" | "stylesheetUrl" | "css">

Returns​

Pick<Widget, "subredditName" | "id" | "name"> & Pick<CustomWidget, "text" | "height" | "images" | "stylesheetUrl" | "css">

Overrides​

Widget.toJSON