Skip to main content
Version: Next

CommunityListWidget

@devvit/public-api v0.12.14-dev

Class: CommunityListWidget

Extends​

Constructors​

new CommunityListWidget()​

new CommunityListWidget(widgetData, subredditName, metadata): CommunityListWidget

Parameters​

widgetData​

GetWidgetsResponse_WidgetItem

subredditName​

string

metadata​

undefined | Metadata

Returns​

CommunityListWidget

Overrides​

Widget.constructor

Accessors​

communities​

Get Signature​

get communities(): CommunityListWidget_CommunityData[]

Returns​

CommunityListWidget_CommunityData[]

id​

Get Signature​

get id(): string

Returns​

string

Inherited from​

Widget.id

name​

Get Signature​

get name(): string

Returns​

string

Inherited from​

Widget.name

styles​

Get Signature​

get styles(): WidgetStyles

Returns​

WidgetStyles

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

Returns​

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

Overrides​

Widget.toJSON