Class PaginatedListState<T, P>`Abstract`

Type Parameters

T extends Model
P extends PaginatedListParams = PaginatedListParams

Hierarchy

PaginatedListState
- DiscussionListState
- NotificationListState

Index

Constructors

`Protected` constructor

new PaginatedListState<T, P>(params?, page?, pageSize?): PaginatedListState<T, P>
Type Parameters
- T extends Model<T>
- P extends PaginatedListParams = PaginatedListParams
Parameters
- params: P = ...
- page: number = 1
- pageSize: null | number = null
Returns PaginatedListState<T, P>
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:45

Properties

`Protected` initialLoading

initialLoading: boolean = false

`Protected` loadingNext

loadingNext: boolean = false

`Protected` loadingPrev

loadingPrev: boolean = false

`Protected` location

location: PaginationLocation

`Protected` pageSize

pageSize: null | number

`Protected` pages

pages: Page<T>[] = []

`Protected` params

params: P = ...

`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

`Abstract` type

get type(): string
Returns string
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:52

Methods

getParams

getParams(): P
Stored state parameters.

Returns P
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:232

`Protected` getPrevPageNumber

getPrevPageNumber(): number
Returns number
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:245

hasItems

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

Returns boolean

See
isEmpty
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:208

hasNext

hasNext(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:225

hasPrev

hasPrev(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:222

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
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:218

isInitialLoading

isInitialLoading(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:193

isLoading

isLoading(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:190

isLoadingNext

isLoadingNext(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:199

isLoadingPrev

isLoadingPrev(): boolean
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:196

loadNext

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

`Protected` loadPage

loadPage(page?): Promise<ApiResponsePlural<T>>
Load a new page of results.
Parameters
- page: number = 1
Returns Promise<ApiResponsePlural<T>>
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:109

loadPrev

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

`Protected` paramsChanged

paramsChanged(newParams): boolean
Parameters
- newParams: P
Returns boolean
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:257

`Protected` parseResults

parseResults(pg, results): void
Parameters
- pg: number
- results: ApiResponsePlural<T>
Returns void
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:84

refresh

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

refreshParams

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

See
requestParams
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:156

`Protected` 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

Abstract

See
loadPage
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:144

Class PaginatedListState<T, P>Abstract

Type Parameters

T extends Model

P extends PaginatedListParams = PaginatedListParams

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

T extends Model<T>

P extends PaginatedListParams = PaginatedListParams

Parameters

params: P = ...

page: number = 1

pageSize: null | number = null

Returns PaginatedListState<T, P>

Properties

Protected initialLoading

Protected loadingNext

Protected loadingPrev

Protected location

Protected pageSize

Protected pages

Protected params

Static DEFAULT_PAGE_SIZE

Accessors

Abstract type

Returns string

Methods

clear

Returns void

Protected getAllItems

Returns T[]

getLocation

Returns PaginationLocation

Protected getNextPageNumber

Returns number

getPages

Returns Page<T>[]

getParams

Returns P

Protected getPrevPageNumber

Returns number

hasItems

Returns boolean

See

hasNext

Returns boolean

hasPrev

Returns boolean

isEmpty

Returns boolean

See

isInitialLoading

Returns boolean

isLoading

Returns boolean

isLoadingNext

Returns boolean

isLoadingPrev

Returns boolean

loadNext

Returns Promise<void>

Protected loadPage

Parameters

page: number = 1

Returns Promise<ApiResponsePlural<T>>

loadPrev

Returns Promise<void>

Protected paramsChanged

Parameters

newParams: P

Returns boolean

Protected parseResults

Parameters

pg: number

Class PaginatedListState<T, P>`Abstract`

`Protected` constructor

`Protected` initialLoading

`Protected` loadingNext

`Protected` loadingPrev

`Protected` location

`Protected` pageSize

`Protected` pages

`Protected` params

`Static` DEFAULT_PAGE_SIZE

`Abstract` type

`Protected` getAllItems

`Protected` getNextPageNumber

`Protected` getPrevPageNumber

`Protected` loadPage

`Protected` paramsChanged

`Protected` parseResults

`Protected` requestParams