Skip to main content

SubredditRulesWidget

@devvit/public-api v0.12.13-dev

Class: SubredditRulesWidget

Extends​

Constructors​

new SubredditRulesWidget()​

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

Parameters​

subredditAboutRulesRsp​

SubredditAboutRulesResponse

widgetData​

GetWidgetsResponse_WidgetItem

subredditName​

string

metadata​

undefined | Metadata

Returns​

SubredditRulesWidget

Overrides​

Widget.constructor

Accessors​

id​

Get Signature​

get id(): string

Returns​

string

Inherited from​

Widget.id

name​

Get Signature​

get name(): string

Returns​

string

Inherited from​

Widget.name

rules​

Get Signature​

get rules(): SubredditRule[]

Returns​

SubredditRule[]

subredditName​

Get Signature​

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