Class NotificationListState

Hierarchy (View Summary)

PaginatedListState<Notification>
- NotificationListState

Constructors

constructor

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

Properties

`Protected`initialLoading

initialLoading: boolean = false

`Protected`loadingNext

loadingNext: boolean = false

`Protected`loadingPage

loadingPage: boolean = false

`Protected`loadingPrev

loadingPrev: boolean = false

`Protected`location

location: PaginationLocation

`Protected`pages

pages: Page<Notification>[] = []

pageSize

pageSize: number | null

`Protected`params

params: PaginatedListParams = ...

totalItems

totalItems: number | null = null

`Static`DEFAULT_PAGE_SIZE

DEFAULT_PAGE_SIZE: number = 20

This value should not be relied upon when preloading an API document. In those cases the pageSize should be taken from the meta information of the preloaded document. Checkout DiscussionListState.loadPage for an example.

Accessors

type

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

Methods

changeFilter

changeFilter(key: string, value: any): void
Parameters
- key: string
- value: any
Returns void
Inherited from PaginatedListState.changeFilter
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:382

changeSort

changeSort(sort: string): void
Parameters
- sort: string
Returns void
Inherited from PaginatedListState.changeSort
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:372

clear

clear(): void
Returns void
Inherited from PaginatedListState.clear
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:68

currentSort

currentSort(): string | undefined
Returns string | undefined
Inherited from PaginatedListState.currentSort
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:368

deleteAll

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

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

`Protected`getAllItems

getAllItems(): Notification[]
Returns Notification[]
Inherited from PaginatedListState.getAllItems
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:326

getLocation

getLocation(): PaginationLocation
Returns PaginationLocation
Inherited from PaginatedListState.getLocation
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:251

`Protected`getNextPageNumber

getNextPageNumber(): number
Returns number
Inherited from PaginatedListState.getNextPageNumber
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:301

getPages

getPages(): Page<Notification>[]
Returns Page<Notification>[]
Inherited from PaginatedListState.getPages
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:248

getParams

getParams(): PaginatedListParams
Stored state parameters.

Returns PaginatedListParams
Inherited from PaginatedListState.getParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:297

`Protected`getPrevPageNumber

getPrevPageNumber(): number
Returns number
Inherited from PaginatedListState.getPrevPageNumber
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:310

getSort

getSort(): string
Returns string
Inherited from PaginatedListState.getSort
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:356

goto

goto(page: number): Promise<void>
Parameters
- page: number
Returns Promise<void>
Inherited from PaginatedListState.goto
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:230

hasItems

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

Returns boolean
See
isEmpty
Inherited from PaginatedListState.hasItems
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:273

hasNext

hasNext(): boolean
Returns boolean
Inherited from PaginatedListState.hasNext
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:290

hasPrev

hasPrev(): boolean
Returns boolean
Inherited from PaginatedListState.hasPrev
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:287

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

Returns boolean
See
hasItems
Inherited from PaginatedListState.isEmpty
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:283

isInitialLoading

isInitialLoading(): boolean
Returns boolean
Inherited from PaginatedListState.isInitialLoading
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:258

isLoading

isLoading(): boolean
Returns boolean
Inherited from PaginatedListState.isLoading
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:255

isLoadingNext

isLoadingNext(): boolean
Returns boolean
Inherited from PaginatedListState.isLoadingNext
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:264

isLoadingPrev

isLoadingPrev(): boolean
Returns boolean
Inherited from PaginatedListState.isLoadingPrev
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:261

isSearchResults

isSearchResults(): boolean
In the last request, has the user searched for a model?

Returns boolean
Inherited from PaginatedListState.isSearchResults
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:335

load

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

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

loadNext

loadNext(): Promise<void>
Returns Promise<void>
Inherited from PaginatedListState.loadNext
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:86

`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 flarum/framework/core/js/src/common/states/PaginatedListState.ts:123

loadPrev

loadPrev(): Promise<void>
Returns Promise<void>
Inherited from PaginatedListState.loadPrev
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:74

markAllAsRead

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

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

`Protected`mutateRequestParams

mutateRequestParams(
params: ApiQueryParamsPlural,
page: number,
): ApiQueryParamsPlural
Parameters
- params: ApiQueryParamsPlural
- page: number
Returns ApiQueryParamsPlural
Inherited from PaginatedListState.mutateRequestParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:162

`Protected`paramsChanged

paramsChanged(newParams: PaginatedListParams): boolean
Parameters
- newParams: PaginatedListParams
Returns boolean
Inherited from PaginatedListState.paramsChanged
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:322

`Protected`parseResults

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

push

push(model: Notification): void
Parameters
- model: Notification
Returns void
Inherited from PaginatedListState.push
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:339

refresh

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

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
Parameters
- newParams: PaginatedListParams
- page: number
Returns Promise<void>
See
requestParams
Inherited from PaginatedListState.refreshParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:210

remove

remove(model: Notification): void
Parameters
- model: Notification
Returns void
Inherited from PaginatedListState.remove
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:395

`Protected` `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
Inherited from PaginatedListState.requestParams
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:198

sortMap

sortMap(): SortMap
Returns SortMap
Inherited from PaginatedListState.sortMap
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:360

sortValue

sortValue(sort: SortMapItem): string | undefined
Parameters
- sort: SortMapItem
Returns string | undefined
Inherited from PaginatedListState.sortValue
- Defined in flarum/framework/core/js/src/common/states/PaginatedListState.ts:364