Class DialogListState<P>

Type Parameters

P extends DialogListParams = DialogListParams

Hierarchy (View Summary)

PaginatedListState<Dialog, P>
- DialogListState

Index

Constructors

Properties

Accessors

Methods

getAllItems load markAllAsRead requestParams sortMap

Constructors

constructor

new DialogListState<P extends DialogListParams = DialogListParams>(
    params: P,
    page?: number,
    perPage?: number | null,
): DialogListState<P>
Type Parameters
- P extends DialogListParams = DialogListParams
Parameters
- params: P
- page: number = 1
- perPage: number | null = null
Returns DialogListState<P>
Overrides PaginatedListState.constructor
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:13

Properties

`Protected`lastCount

lastCount: number = 0

Accessors

type

get type(): string
Returns string
Overrides PaginatedListState.type
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:17

Methods

getAllItems

getAllItems(): Dialog[]
Returns Dialog[]
Overrides PaginatedListState.getAllItems
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:21

load

load(): Promise<void>
Returns Promise<void>
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:45

markAllAsRead

markAllAsRead(): Promise<void>
Returns Promise<void>
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:60

`Abstract`requestParams

requestParams(): PaginatedListRequestParams
Get the parameters that should be passed in the API request. Do not include page offset unless subclass overrides loadPage.

Returns PaginatedListRequestParams
See
loadPage
Overrides PaginatedListState.requestParams
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:25

sortMap

sortMap(): SortMap
Returns SortMap
Overrides PaginatedListState.sortMap
- Defined in extensions/messages/js/src/forum/states/DialogListState.ts:35