A class representing query to retrieve the list of GroupChannels that have been deactivated by channel rotation for the current User. The query can be get by calling sendbirdChat.groupChannel.createInactiveChannelListQuery(). Unlike createMyGroupChannelListQuery(), the returned channels are a minimal "channel" view (members, receipts, last message, etc. are not included) and are not reflected into any GroupChannelCollection or the channel cache.

Hierarchy

  • default
    • InactiveChannelListQuery

Properties

Accessors

Methods

Properties

customType: null | string = null

The custom type filter. It will return null if the custom type filter hasn't been set before.

limit: number = DEFAULT_LIST_QUERY_LIMIT

The maximum number of data per queried page.

order: InactiveChannelListOrder = InactiveChannelListOrder.LATEST

Result order of the inactive channels.

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<GroupChannel[]>

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

  • Returns object

    Serializes the InactiveChannelListQuery instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData.