Class DiscussionListState<P>

Type Parameters

P extends DiscussionListParams = DiscussionListParams

Hierarchy

PaginatedListState<Discussion, P>
- DiscussionListState

Constructors

constructor

new DiscussionListState<P>(params, page?): DiscussionListState<P>
Type Parameters
- P extends DiscussionListParams = DiscussionListParams
Parameters
- params: P
- page: number = 1
Returns DiscussionListState<P>
Overrides PaginatedListState.constructor
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:17

Properties

`Protected` eventEmitter

eventEmitter: EventEmitter

`Protected` extraDiscussions

extraDiscussions: Discussion[] = []

`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<Discussion>[] = []

`Protected` params

params: P = ...

Accessors

type

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

Methods

addDiscussion

addDiscussion(discussion): void
Add a discussion to the top of the list.
Parameters
- discussion: Discussion
Returns void
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:111

clear

clear(): void
Returns void
Overrides PaginatedListState.clear
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:54

deleteDiscussion

deleteDiscussion(discussion): void
Parameters
- discussion: Discussion
Returns void
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:89

`Protected` getAllItems

getAllItems(): Discussion[]
Returns Discussion[]
Overrides PaginatedListState.getAllItems
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:118

getLocation

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

`Protected` getNextPageNumber

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

getPages

getPages(): Page<Discussion>[]
Returns Page<Discussion>[]
Overrides PaginatedListState.getPages
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:122

getParams

getParams(): P
Stored state parameters.

Returns P
Inherited from PaginatedListState.getParams
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:214

`Protected` getPrevPageNumber

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

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

hasNext

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

hasPrev

hasPrev(): boolean
Returns boolean
Inherited from PaginatedListState.hasPrev
- Defined in framework/core/js/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

Returns boolean

See
hasItems
Inherited from PaginatedListState.isEmpty
- Defined in framework/core/js/src/common/states/PaginatedListState.ts:200

isInitialLoading

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

isLoading

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

isLoadingNext

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

isLoadingPrev

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

isSearchResults

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

Returns boolean
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:81

loadNext

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

`Protected` loadPage

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

loadPrev

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

`Protected` paramsChanged

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

`Protected` parseResults

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

refresh

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

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

removeDiscussion

removeDiscussion(discussion): void
Parameters
- discussion: Discussion
Returns void
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:85

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
Overrides PaginatedListState.requestParams
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:27

sortMap

sortMap(): any
Get a map of sort keys (which appear in the URL, and are used for translation) to the API sort value that they represent.

Returns any
- Defined in framework/core/js/src/forum/states/DiscussionListState.ts:64

Generated using TypeDoc v0.24.8