Class: SubredditRulesWidget

models.SubredditRulesWidget

Hierarchy

• Widget

  ↳ SubredditRulesWidget

Table of contents

Constructors

• constructor

Accessors

• id
• name
• rules
• subredditName

Methods

• delete
• toJSON

Constructors

constructor

• new SubredditRulesWidget(subredditAboutRulesRsp, widgetData, subredditName, metadata): SubredditRulesWidget

Parameters

Name	Type
subredditAboutRulesRsp	SubredditAboutRulesResponse
widgetData	GetWidgetsResponse_WidgetItem
subredditName	string
metadata	undefined | Metadata

Returns

SubredditRulesWidget

Overrides

Widget.constructor

Accessors

id

• get id(): string

Returns

string

Inherited from

Widget.id

---

name

• get name(): string

Returns

string

Inherited from

Widget.name

---

rules

• get rules(): SubredditRule[]

Returns

SubredditRule[]

---

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<SubredditRulesWidget, "rules">

Returns

Pick<Widget, "subredditName" | "id" | "name"> & Pick<SubredditRulesWidget, "rules">

Overrides

Widget.toJSON