Class: CustomWidget

Hierarchy

• Widget

  ↳ CustomWidget

Table of contents

Constructors

• constructor

Accessors

• css
• height
• id
• images
• name
• stylesheetUrl
• subredditName
• text

Methods

• delete
• toJSON
• add
• create
• delete
• getWidgets
• reorder
• update

Constructors

constructor

• new CustomWidget(widgetData, subredditName, metadata?)

Parameters

Name	Type
widgetData	GetWidgetsResponse_WidgetItem
subredditName	string
metadata?	Metadata

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(): Object

Returns

Object

Name	Type
css	string
height	number
id	string
images	WidgetImage[]
name	string
stylesheetUrl	string
subredditName	string
text	string

Overrides

Widget.toJSON

---

add

▸ Static add(widgetData, metadata): Promise< ImageWidget | CalendarWidget | TextAreaWidget | ButtonWidget | CommunityListWidget | PostFlairWidget | CustomWidget>

Parameters

Name	Type
widgetData	AddWidgetData
metadata	undefined | Metadata

Returns

Promise< ImageWidget | CalendarWidget | TextAreaWidget | ButtonWidget | CommunityListWidget | PostFlairWidget | CustomWidget>

Inherited from

Widget.add

---

create

▸ Static create(options, metadata): Promise< CustomWidget>

Parameters

Name	Type
options	AddCustomWidgetRequest
metadata	undefined | Metadata

Returns

Promise< CustomWidget>

---

delete

▸ Static delete(subredditName, id, metadata?): Promise< void>

Parameters

Name	Type
subredditName	string
id	string
metadata?	Metadata

Returns

Promise< void>

Inherited from

Widget.delete

---

getWidgets

▸ Static getWidgets(subredditName, metadata?): Promise< (ImageWidget | CalendarWidget | TextAreaWidget | ButtonWidget | CommunityListWidget | PostFlairWidget | CustomWidget)[]>

Parameters

Name	Type
subredditName	string
metadata?	Metadata

Returns

Promise< (ImageWidget | CalendarWidget | TextAreaWidget | ButtonWidget | CommunityListWidget | PostFlairWidget | CustomWidget)[]>

Inherited from

Widget.getWidgets

---

reorder

▸ Static reorder(subredditName, orderByIds, metadata?): Promise< void>

Parameters

Name	Type
subredditName	string
orderByIds	string[]
metadata?	Metadata

Returns

Promise< void>

Inherited from

Widget.reorder

---

update

▸ Static update(options, metadata): Promise< CustomWidget>

Parameters

Name	Type
options	UpdateCustomWidgetRequest
metadata	undefined | Metadata

Returns

Promise< CustomWidget>