Class: Widget

Hierarchy

• Widget

  ↳ ImageWidget

  ↳ CalendarWidget

  ↳ TextAreaWidget

  ↳ ButtonWidget

  ↳ CommunityListWidget

  ↳ PostFlairWidget

  ↳ CustomWidget

Table of contents

Constructors

• constructor

Accessors

• id
• name
• subredditName

Methods

• delete
• toJSON
• add
• delete
• getWidgets
• reorder

Constructors

constructor

• new Widget(widgetData, subredditName, metadata?)

Parameters

Name	Type
widgetData	GetWidgetsResponse_WidgetItem
subredditName	string
metadata?	Metadata

Accessors

id

• get id(): string

Returns

string

---

name

• get name(): string

Returns

string

---

subredditName

• get subredditName(): string

Returns

string

Methods

delete

▸ delete(): Promise<void>

Returns

Promise<void>

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
id	string
name	string
subredditName	string

---

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>

---

delete

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

Parameters

Name	Type
subredditName	string
id	string
metadata?	Metadata

Returns

Promise<void>

---

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)[]>

---

reorder

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

Parameters

Name	Type
subredditName	string
orderByIds	string[]
metadata?	Metadata

Returns

Promise<void>