Class NotificationListState

Hierarchy

PaginatedListState<Notification>
- NotificationListState

Index

Constructors

constructor

new NotificationListState(): NotificationListState
Returns NotificationListState
Overrides PaginatedListState.constructor
- Defined in src/forum/states/NotificationListState.ts:6

Properties

`Protected` initialLoading

initialLoading: boolean = false

`Protected` loadingNext

loadingNext: boolean = false

`Protected` loadingPrev

loadingPrev: boolean = false

`Protected` location

location: PaginationLocation

`Protected` pageSize

pageSize: number

`Protected` pages

pages: Page<Notification>[] = []

`Protected` params

params: PaginatedListParams = ...

Accessors

type

get type(): string
Returns string
Overrides PaginatedListState.type
- Defined in src/forum/states/NotificationListState.ts:10

Methods

clear

clear(): void
Returns void
Inherited from PaginatedListState.clear
- Defined in src/common/states/PaginatedListState.ts:47

deleteAll

deleteAll(): undefined | Promise<unknown>
Delete all of the notifications for this user.

Returns undefined | Promise<unknown>
- Defined in src/forum/states/NotificationListState.ts:53

`Protected` getAllItems

getAllItems(): Notification[]
Returns Notification[]
Inherited from PaginatedListState.getAllItems
- Defined in src/common/states/PaginatedListState.ts:243

getLocation

getLocation(): PaginationLocation
Returns PaginationLocation
Inherited from PaginatedListState.getLocation
- Defined in src/common/states/PaginatedListState.ts:168

`Protected` getNextPageNumber

getNextPageNumber(): number
Returns number
Inherited from PaginatedListState.getNextPageNumber
- Defined in src/common/states/PaginatedListState.ts:218

getPages

getPages(): Page<Notification>[]
Returns Page<Notification>[]
Inherited from PaginatedListState.getPages
- Defined in src/common/states/PaginatedListState.ts:165

getParams

getParams(): PaginatedListParams
Stored state parameters.

Returns PaginatedListParams
Inherited from PaginatedListState.getParams
- Defined in src/common/states/PaginatedListState.ts:214

`Protected` getPrevPageNumber

getPrevPageNumber(): number
Returns number
Inherited from PaginatedListState.getPrevPageNumber
- Defined in src/common/states/PaginatedListState.ts:227

hasItems

hasItems(): boolean
Returns true when the number of items across all loaded pages is not 0.

See
isEmpty

Returns boolean
Inherited from PaginatedListState.hasItems
- Defined in src/common/states/PaginatedListState.ts:190

hasNext

hasNext(): boolean
Returns boolean
Inherited from PaginatedListState.hasNext
- Defined in src/common/states/PaginatedListState.ts:207

hasPrev

hasPrev(): boolean
Returns boolean
Inherited from PaginatedListState.hasPrev
- Defined in src/common/states/PaginatedListState.ts:204

isEmpty

isEmpty(): boolean
Returns true when there aren't any items and the state has already done its initial loading. If you want to know whether there are items regardless of load state, use hasItems() instead

See
hasItems

Returns boolean
Inherited from PaginatedListState.isEmpty
- Defined in src/common/states/PaginatedListState.ts:200

isInitialLoading

isInitialLoading(): boolean
Returns boolean
Inherited from PaginatedListState.isInitialLoading
- Defined in src/common/states/PaginatedListState.ts:175

isLoading

isLoading(): boolean
Returns boolean
Inherited from PaginatedListState.isLoading
- Defined in src/common/states/PaginatedListState.ts:172

isLoadingNext

isLoadingNext(): boolean
Returns boolean
Inherited from PaginatedListState.isLoadingNext
- Defined in src/common/states/PaginatedListState.ts:181

isLoadingPrev

isLoadingPrev(): boolean
Returns boolean
Inherited from PaginatedListState.isLoadingPrev
- Defined in src/common/states/PaginatedListState.ts:178

load

load(): Promise<void>
Load the next page of notification results.

Returns Promise<void>
- Defined in src/forum/states/NotificationListState.ts:17

loadNext

loadNext(): Promise<void>
Returns Promise<void>
Inherited from PaginatedListState.loadNext
- Defined in src/common/states/PaginatedListState.ts:65

`Protected` loadPage

loadPage(page?: number): Promise<ApiResponsePlural<Notification>>
Load a new page of results.
Parameters
- page: number = 1
Returns Promise<ApiResponsePlural<Notification>>
Inherited from PaginatedListState.loadPage
- Defined in src/common/states/PaginatedListState.ts:102

loadPrev

loadPrev(): Promise<void>
Returns Promise<void>
Inherited from PaginatedListState.loadPrev
- Defined in src/common/states/PaginatedListState.ts:53

markAllAsRead

markAllAsRead(): undefined | Promise<unknown>
Mark all of the notifications as read.

Returns undefined | Promise<unknown>
- Defined in src/forum/states/NotificationListState.ts:35

`Protected` paramsChanged

paramsChanged(newParams: PaginatedListParams): boolean
Parameters
- newParams: PaginatedListParams
Returns boolean
Inherited from PaginatedListState.paramsChanged
- Defined in src/common/states/PaginatedListState.ts:239

`Protected` parseResults

parseResults(pg: number, results: ApiResponsePlural<Notification>): void
Parameters
- pg: number
- results: ApiResponsePlural<Notification>
Returns void
Inherited from PaginatedListState.parseResults
- Defined in src/common/states/PaginatedListState.ts:77

refresh

refresh(page?: number): Promise<void>
Parameters
- page: number = 1
Returns Promise<void>
Inherited from PaginatedListState.refresh
- Defined in src/common/states/PaginatedListState.ts:148

refreshParams

refreshParams(newParams: PaginatedListParams, page: number): Promise<void>
Update the this.params object, calling refresh if they have changed. Use requestParams for converting this.params into API parameters

See
requestParams
Parameters
- newParams: PaginatedListParams
- page: number
Returns Promise<void>
Inherited from PaginatedListState.refreshParams
- Defined in src/common/states/PaginatedListState.ts:138

`Protected` requestParams

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

Abstract

See
loadPage

Returns PaginatedListRequestParams
Inherited from PaginatedListState.requestParams
- Defined in src/common/states/PaginatedListState.ts:126

Generated using TypeDoc v0.23.24