Class OpenChannelListQuery

Description

A class representing query to retrieve OpenChannel list. The query can be get by calling sendbirdChat.openChannel.createOpenChannelListQuery().

Hierarchy

  • default
    • OpenChannelListQuery

Properties

customTypes includeFrozen includeMetaData limit nameKeyword urlKeyword

Accessors

hasNext isLoading

Methods

next

Properties

Readonly customTypes

customTypes: null | string[] = null

Description

A filter to return only channels with the specified customType.

Readonly includeFrozen

includeFrozen: boolean = true

Description

Indicate whether to include frozen channels or not. (default: true)

Readonly includeMetaData

includeMetaData: boolean = true

Description

Indicate whether to include channel metadata on fetch. (default: true)

Readonly limit

limit: number = DEFAULT_LIST_QUERY_LIMIT

Description

The maximum number of data per queried page.

Readonly nameKeyword

nameKeyword: null | string = null

Description

Indicate search keyword for channel name.

Readonly urlKeyword

urlKeyword: null | string = null

Description

Indicate search keyword for channel URL.

Accessors

hasNext

  • get hasNext(): boolean

  • Returns boolean

    Description

    Whether there is a next page.

isLoading

  • get isLoading(): boolean

  • Returns boolean

    Description

    Whether the current query is in communication progress with server.

Methods

next

  • Returns Promise<OpenChannel[]>

    Description

    Gets the list of OpenChannels. If this method is repeatedly called after each next is finished, it retrieves the following pages of the OpenChannel list. If there is no more pages to be read, an empty List (not null) is returned.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc