SendbirdChat/com.sendbird.android.channel.query/AIAgentGroupChannelListQuery

AIAgentGroupChannelListQuery

class AIAgentGroupChannelListQuery

A class representing query to retrieve GroupChannel list for the current User.

Currently, 1 kind of GroupChannel list can be queried.

The list of GroupChannels the current User is a member of.

The query can be get by calling SendbirdChat.AIAgent.createMyGroupChannelListQuery.

Properties

aiAgentChannelFilter

val aiAgentChannelFilter: AIAgentChannelFilter

The filter applied to AI agent channels. It determines whether to include or exclude AI agent channels in the query results.

aiAgentConversationStatusFilter

val aiAgentConversationStatusFilter: List<ConversationStatus>?

The filter applied to AI agent conversation statuses. It allows filtering channels based on the status of their conversations.

aiAgentIds

val aiAgentIds: List<String>

The list of AI agent IDs to filter the channels. Only channels associated with these AI agents will be included in the results.

deskChannelFilter

val deskChannelFilter: DeskChannelFilter

The filter applied to Desk channels. It determines whether to include or exclude Desk channels in the query results.

hasNext

var hasNext: Boolean

Returns the token for the next page of results. This token is used to fetch the next set of channels. If the token is empty, it indicates that there are no more channels to fetch.

isLoading

@get:Synchronized

var isLoading: Boolean

Indicates whether the query is currently loading channels.

lastResponseAt

@Volatile

var lastResponseAt: Long?

The timestamp of the last response received from the server. This timestamp is updated each time a new page of channels is fetched. Use internal only

limit

val limit: Int

Returns the maximum number of channels to load per page. This value is set when the query is created and determines how many channels will be returned in each response.

pinnedChannelUrls

val pinnedChannelUrls: List<String>

The list of pinned channel URLs. These channels are prioritized in the query results.

Functions

belongsTo

fun belongsTo(channel: GroupChannel): Boolean

Checks if the given GroupChannel belongs to this query based on the current parameters. This method evaluates the channel against the filters set in the query parameters.

@Synchronized

fun next(handler: GroupChannelsCallbackHandler?)

Fetches the next page of GroupChannels asynchronously. If the query is already loading or there are no more channels to fetch, it will return immediately with an error or an empty list.

toString

open override fun toString(): String