Class GroupChannelCollection

Hierarchy (view full)

BaseChannelCollection<GroupChannelFilter>
- GroupChannelCollection

Index

Constructors

Properties

Accessors

channels handler hasMore

Methods

dispose loadMore setGroupChannelCollectionHandler

Constructors

constructor

new GroupChannelCollection(_iid, params?): GroupChannelCollection
Parameters
- _iid: string
- params: GroupChannelCollectionParams = {}
Returns GroupChannelCollection
Overrides BaseChannelCollection<GroupChannelFilter>.constructor

Properties

`Readonly`filter

filter: GroupChannelFilter

`Readonly`order

order: GroupChannelListOrder

The order of the channel list.

Accessors

channels

get channels(): GroupChannel[]
Returns GroupChannel[]
Inherited from BaseChannelCollection.channels

handler

get handler(): BaseChannelCollectionEventHandler
Returns BaseChannelCollectionEventHandler
Inherited from BaseChannelCollection.handler

hasMore

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

Returns boolean
Inherited from BaseChannelCollection.hasMore

Methods

dispose

dispose(): void
Returns void
Description
Disposes current GroupChannelCollection and stops all events from being received.

Overrides BaseChannelCollection.dispose

loadMore

loadMore(): Promise<GroupChannel[]>
Returns Promise<GroupChannel[]>
Description
Loads next channel lists with the filter and the order.

Inherited from BaseChannelCollection.loadMore

setGroupChannelCollectionHandler

setGroupChannelCollectionHandler(handler): void
Parameters
- handler: BaseChannelCollectionEventHandler
Returns void
Description
Sets GroupChannelCollection event handler.

Inherited from BaseChannelCollection.setGroupChannelCollectionHandler