Class: CommunityListWidget

models.CommunityListWidget

Hierarchy

• Widget

  ↳ CommunityListWidget

Table of contents

Constructors

• constructor

Accessors

• communities
• id
• name
• styles
• subredditName

Methods

• delete
• toJSON

Constructors

constructor

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

Parameters

Name	Type
widgetData	GetWidgetsResponse_WidgetItem
subredditName	string
metadata	undefined | Metadata

Returns

CommunityListWidget

Overrides

Widget.constructor

Accessors

communities

• get communities(): CommunityListWidget_CommunityData[]

Returns

CommunityListWidget_CommunityData[]

---

id

• get id(): string

Returns

string

Inherited from

Widget.id

---

name

• get name(): string

Returns

string

Inherited from

Widget.name

---

styles

• get styles(): WidgetStyles

Returns

WidgetStyles

---

subredditName

• 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<CommunityListWidget, "communities" | "styles">

Returns

Pick<Widget, "subredditName" | "id" | "name"> & Pick<CommunityListWidget, "communities" | "styles">

Overrides

Widget.toJSON