Class GroupChannelCollection

Description

Collection that handles channel lists, also supporting local caching.

Hierarchy

GroupChannelCollection

Index

Properties

channels filter order

Accessors

Methods

dispose loadMore setGroupChannelCollectionHandler

Properties

`Readonly` channels

channels: GroupChannel[] = []

The list of GroupChannels managed by collection.

`Readonly` filter

filter: GroupChannelFilter

The filter to show matched GroupChannels only.

`Readonly` order

order: GroupChannelListOrder

The order of the channel list.

Accessors

hasMore

get hasMore(): boolean
Whether the collection has more channels to load.

Returns boolean

Methods

dispose

dispose(): void
Returns void

Description
Disposes current GroupChannelCollection and stops all events from being received.

loadMore

loadMore(): Promise<GroupChannel[]>
Returns Promise<GroupChannel[]>

Description
Loads next channel lists with the filter and the order.

setGroupChannelCollectionHandler

setGroupChannelCollectionHandler(handler): void
Parameters
- handler: GroupChannelCollectionEventHandler
Returns void

Description
Sets GroupChannelCollection event handler.

Generated using TypeDoc