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

Hierarchy

  • default
    • OpenChannelListQuery

Properties

customTypes: null | string[] = null

A filter to return only channels with the specified customType.

includeFrozen: boolean = true

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

includeMetaData: boolean = true

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

limit: number = DEFAULT_LIST_QUERY_LIMIT

The maximum number of data per queried page.

nameKeyword: null | string = null

Indicate search keyword for channel name.

urlKeyword: null | string = null

Indicate search keyword for channel URL.

Accessors

  • get hasNext(): boolean
  • Returns boolean

    Whether there is a next page.

  • get isLoading(): boolean
  • Returns boolean

    Whether the current query is in communication progress with server.

Methods

  • Returns Promise<OpenChannel[]>

    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.