Add support for PredefinedFilters for QueryChannels

stream-chat-android-client-test/src/main/java/io/getstream/chat/android/client/test/Mother.kt

@@ -662,7 +662,17 @@ public fun randomQueryChannelsSpec(
     filter: FilterObject = NeutralFilterObject,
     sort: QuerySorter<Channel> = QuerySortByField(),
     cids: Set<String> = emptySet(),
-): QueryChannelsSpec = QueryChannelsSpec(filter, sort).apply { this.cids = cids }
+    predefinedFilterName: String? = null,
+    predefinedFilterValues: Map<String, Any>? = null,
+    predefinedSortValues: Map<String, Any>? = null,
+): QueryChannelsSpec = QueryChannelsSpec.create(
+    filter = filter,
+    querySort = sort,
+    cids = cids,
+    predefinedFilterName = predefinedFilterName,
+    predefinedFilterValues = predefinedFilterValues,
+    predefinedSortValues = predefinedSortValues,
+)
 
 public fun randomNotificationRemovedFromChannelEvent(
     cid: String = randomCID(),

stream-chat-android-client/api/stream-chat-android-client.api

@@ -582,25 +582,39 @@ public class io/getstream/chat/android/client/api/models/QueryChannelRequest : i
 }
 
 public final class io/getstream/chat/android/client/api/models/QueryChannelsRequest : io/getstream/chat/android/client/api/models/ChannelRequest {
+	public fun <init> (I)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;I)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;II)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;)V
 	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;)V
-	public synthetic fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;Ljava/util/Map;)V
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)V
+	public synthetic fun <init> (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Lio/getstream/chat/android/models/FilterObject;
 	public final fun component2 ()I
 	public final fun component3 ()I
 	public final fun component4 ()Lio/getstream/chat/android/models/querysort/QuerySorter;
 	public final fun component5 ()Ljava/lang/Integer;
 	public final fun component6 ()Ljava/lang/Integer;
-	public final fun copy (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;)Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;
-	public static synthetic fun copy$default (Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;ILjava/lang/Object;)Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;
+	public final fun component7 ()Ljava/lang/String;
+	public final fun component8 ()Ljava/util/Map;
+	public final fun component9 ()Ljava/util/Map;
+	public final fun copy (Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;Lio/getstream/chat/android/models/FilterObject;IILio/getstream/chat/android/models/querysort/QuerySorter;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;ILjava/lang/Object;)Lio/getstream/chat/android/client/api/models/QueryChannelsRequest;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getFilter ()Lio/getstream/chat/android/models/FilterObject;
+	public final fun getFilterValues ()Ljava/util/Map;
 	public final fun getLimit ()I
 	public final fun getMemberLimit ()Ljava/lang/Integer;
 	public final fun getMessageLimit ()Ljava/lang/Integer;
 	public final fun getOffset ()I
+	public final fun getPredefinedFilter ()Ljava/lang/String;
 	public fun getPresence ()Z
 	public final fun getQuerySort ()Lio/getstream/chat/android/models/querysort/QuerySorter;
 	public final fun getSort ()Ljava/util/List;
+	public final fun getSortValues ()Ljava/util/Map;
 	public fun getState ()Z
 	public fun getWatch ()Z
 	public fun hashCode ()I
@@ -3051,6 +3065,34 @@ public final class io/getstream/chat/android/client/internal/offline/repository/
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class io/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Predefined : io/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier {
+	public fun <init> (Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)V
+	public final fun component1 ()Ljava/lang/String;
+	public final fun component2 ()Ljava/util/Map;
+	public final fun component3 ()Ljava/util/Map;
+	public final fun copy (Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Predefined;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Predefined;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;ILjava/lang/Object;)Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Predefined;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getFilterValues ()Ljava/util/Map;
+	public final fun getName ()Ljava/lang/String;
+	public final fun getSortValues ()Ljava/util/Map;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class io/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Standard : io/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier {
+	public fun <init> (Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;)V
+	public final fun component1 ()Lio/getstream/chat/android/models/FilterObject;
+	public final fun component2 ()Lio/getstream/chat/android/models/querysort/QuerySorter;
+	public final fun copy (Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;)Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Standard;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Standard;Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;ILjava/lang/Object;)Lio/getstream/chat/android/client/internal/state/plugin/QueryChannelsIdentifier$Standard;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getFilter ()Lio/getstream/chat/android/models/FilterObject;
+	public final fun getSort ()Lio/getstream/chat/android/models/querysort/QuerySorter;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
 public final class io/getstream/chat/android/client/logger/ChatLogLevel : java/lang/Enum {
 	public static final field ALL Lio/getstream/chat/android/client/logger/ChatLogLevel;
 	public static final field DEBUG Lio/getstream/chat/android/client/logger/ChatLogLevel;
@@ -3274,6 +3316,7 @@ public final class io/getstream/chat/android/client/query/CreateChannelParams {
 }
 
 public final class io/getstream/chat/android/client/query/QueryChannelsSpec {
+	public static final field Companion Lio/getstream/chat/android/client/query/QueryChannelsSpec$Companion;
 	public fun <init> (Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;)V
 	public final fun component1 ()Lio/getstream/chat/android/models/FilterObject;
 	public final fun component2 ()Lio/getstream/chat/android/models/querysort/QuerySorter;
@@ -3282,12 +3325,23 @@ public final class io/getstream/chat/android/client/query/QueryChannelsSpec {
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getCids ()Ljava/util/Set;
 	public final fun getFilter ()Lio/getstream/chat/android/models/FilterObject;
+	public final fun getPredefinedFilterName ()Ljava/lang/String;
+	public final fun getPredefinedFilterValues ()Ljava/util/Map;
+	public final fun getPredefinedSortValues ()Ljava/util/Map;
 	public final fun getQuerySort ()Lio/getstream/chat/android/models/querysort/QuerySorter;
 	public fun hashCode ()I
 	public final fun setCids (Ljava/util/Set;)V
+	public final fun setPredefinedFilterName (Ljava/lang/String;)V
+	public final fun setPredefinedFilterValues (Ljava/util/Map;)V
+	public final fun setPredefinedSortValues (Ljava/util/Map;)V
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class io/getstream/chat/android/client/query/QueryChannelsSpec$Companion {
+	public final fun create (Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;Ljava/util/Set;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;)Lio/getstream/chat/android/client/query/QueryChannelsSpec;
+	public static synthetic fun create$default (Lio/getstream/chat/android/client/query/QueryChannelsSpec$Companion;Lio/getstream/chat/android/models/FilterObject;Lio/getstream/chat/android/models/querysort/QuerySorter;Ljava/util/Set;Ljava/lang/String;Ljava/util/Map;Ljava/util/Map;ILjava/lang/Object;)Lio/getstream/chat/android/client/query/QueryChannelsSpec;
+}
+
 public final class io/getstream/chat/android/client/query/pagination/AnyChannelPaginationRequest {
 	public fun <init> ()V
 	public fun <init> (I)V

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt

@@ -2974,7 +2974,7 @@ internal constructor(
     @CheckResult
     @InternalStreamChatApi
     public fun queryChannelsInternal(request: QueryChannelsRequest): Call<List<Channel>> {
-        return api.queryChannels(request)
+        return api.queryChannels(request).map { it.channels }
     }
 
     /**
@@ -3001,7 +3001,7 @@ internal constructor(
                 this.watch = false
                 this.state = state
             }
-            when (val result = api.queryChannels(request).await()) {
+            when (val result = api.queryChannels(request).map { it.channels }.await()) {
                 is Result.Success -> {
                     val channels = result.value
                     if (channels.isEmpty()) {
@@ -3112,7 +3112,7 @@ internal constructor(
     @CheckResult
     public fun queryChannels(request: QueryChannelsRequest): Call<List<Channel>> {
         logger.d { "[queryChannels] offset: ${request.offset}, limit: ${request.limit}" }
-        return queryChannelsInternal(request = request).doOnStart(userScope) {
+        return api.queryChannels(request).doOnStart(userScope) {
             plugins.forEach { listener ->
                 logger.v { "[queryChannels] #doOnStart; plugin: ${listener::class.qualifiedName}" }
                 listener.onQueryChannelsRequest(request)
@@ -3124,6 +3124,8 @@ internal constructor(
             }
         }.precondition(plugins) {
             onQueryChannelsPrecondition(request)
+        }.map {
+            it.channels
         }.share(userScope) {
             QueryChannelsIdentifier(request)
         }

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/ChatApi.kt

@@ -21,6 +21,7 @@ import io.getstream.chat.android.client.api.models.GetThreadOptions
 import io.getstream.chat.android.client.api.models.PinnedMessagesPagination
 import io.getstream.chat.android.client.api.models.QueryChannelRequest
 import io.getstream.chat.android.client.api.models.QueryChannelsRequest
+import io.getstream.chat.android.client.api.models.QueryChannelsResult
 import io.getstream.chat.android.client.api.models.QueryThreadsRequest
 import io.getstream.chat.android.client.api.models.QueryUsersRequest
 import io.getstream.chat.android.client.api.models.SendActionRequest
@@ -285,7 +286,7 @@ internal interface ChatApi {
     ): Call<List<Message>>
 
     @CheckResult
-    fun queryChannels(query: QueryChannelsRequest): Call<List<Channel>>
+    fun queryChannels(query: QueryChannelsRequest): Call<QueryChannelsResult>
 
     @CheckResult
     fun updateUsers(users: List<User>): Call<List<User>>

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/internal/DistinctChatApi.kt

@@ -20,6 +20,7 @@ import io.getstream.chat.android.client.api.ChatApi
 import io.getstream.chat.android.client.api.models.PinnedMessagesPagination
 import io.getstream.chat.android.client.api.models.QueryChannelRequest
 import io.getstream.chat.android.client.api.models.QueryChannelsRequest
+import io.getstream.chat.android.client.api.models.QueryChannelsResult
 import io.getstream.chat.android.client.api2.optimisation.hash.ChannelQueryKey
 import io.getstream.chat.android.client.api2.optimisation.hash.GetNewerRepliesHash
 import io.getstream.chat.android.client.api2.optimisation.hash.GetPinnedMessagesHash
@@ -133,7 +134,7 @@ internal class DistinctChatApi(
         }
     }
 
-    override fun queryChannels(query: QueryChannelsRequest): Call<List<Channel>> {
+    override fun queryChannels(query: QueryChannelsRequest): Call<QueryChannelsResult> {
         val uniqueKey = query.hashCode()
         StreamLog.d(TAG) { "[queryChannels] query: $query, uniqueKey: $uniqueKey" }
         return getOrCreate(uniqueKey) {

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/internal/DistinctChatApiEnabler.kt

@@ -20,6 +20,7 @@ import io.getstream.chat.android.client.api.ChatApi
 import io.getstream.chat.android.client.api.models.PinnedMessagesPagination
 import io.getstream.chat.android.client.api.models.QueryChannelRequest
 import io.getstream.chat.android.client.api.models.QueryChannelsRequest
+import io.getstream.chat.android.client.api.models.QueryChannelsResult
 import io.getstream.chat.android.models.BannedUser
 import io.getstream.chat.android.models.BannedUsersSort
 import io.getstream.chat.android.models.Channel
@@ -77,7 +78,7 @@ internal class DistinctChatApiEnabler(
         return getApi().getPinnedMessages(channelType, channelId, limit, sort, pagination)
     }
 
-    override fun queryChannels(query: QueryChannelsRequest): Call<List<Channel>> {
+    override fun queryChannels(query: QueryChannelsRequest): Call<QueryChannelsResult> {
         return getApi().queryChannels(query)
     }
 

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/models/PredefinedFilter.kt

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.getstream.chat.android.client.api.models
+
+import io.getstream.chat.android.core.internal.InternalStreamChatApi
+import io.getstream.chat.android.models.Channel
+import io.getstream.chat.android.models.FilterObject
+import io.getstream.chat.android.models.querysort.QuerySorter
+
+/**
+ * Represents a predefined filter parsed by the backend.
+ *
+ * @param name The name/identifier of the predefined filter.
+ * @param filter The parsed filter specification.
+ * @param sort The parsed sort specification, or null if no sort was provided.
+ */
+@InternalStreamChatApi
+public data class PredefinedFilter(
+    val name: String,
+    val filter: FilterObject,
+    val sort: QuerySorter<Channel>?,
+)

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/models/QueryChannelsRequest.kt

@@ -18,26 +18,36 @@ package io.getstream.chat.android.client.api.models
 
 import io.getstream.chat.android.models.Channel
 import io.getstream.chat.android.models.FilterObject
+import io.getstream.chat.android.models.Filters
 import io.getstream.chat.android.models.querysort.QuerySortByField
 import io.getstream.chat.android.models.querysort.QuerySorter
 
 /**
  * Request body class for querying channels.
  *
- * @property filter [FilterObject] conditions used by backend to filter queries response.
+ * @property filter [FilterObject] conditions used by backend to filter queries response. If [predefinedFilter] is
+ * specified, this field is ignored.
  * @property offset Pagination offset.
  * @property limit Number of channels to be returned by this query channels request.
- * @property querySort [QuerySorter] Sort specification for api queries.
+ * @property querySort [QuerySorter] Sort specification for api queries. If [predefinedFilter] is specified, this field
+ * is ignored.
  * @property messageLimit Number of messages in the response. When `null`, the server-side default is used.
  * @property memberLimit Number of members in the response. When `null`, the server-side default is used.
+ * @property predefinedFilter ID of a server-side predefined filter to use instead of [filter].
+ * When set, [filter] and [querySort] are ignored by the backend.
+ * @property filterValues Values to interpolate into the predefined filter template.
+ * @property sortValues Values to interpolate into the predefined sort template.
  */
-public data class QueryChannelsRequest(
-    public val filter: FilterObject,
+public data class QueryChannelsRequest @JvmOverloads constructor(
+    public val filter: FilterObject = Filters.neutral(),
     public var offset: Int = 0,
     public var limit: Int,
     public val querySort: QuerySorter<Channel> = QuerySortByField(),
     public var messageLimit: Int? = null,
     public var memberLimit: Int? = null,
+    public val predefinedFilter: String? = null,
+    public val filterValues: Map<String, Any>? = null,
+    public val sortValues: Map<String, Any>? = null,
 ) : ChannelRequest<QueryChannelsRequest> {
 
     override var state: Boolean = true

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/models/QueryChannelsResult.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.getstream.chat.android.client.api.models
+
+import io.getstream.chat.android.core.internal.InternalStreamChatApi
+import io.getstream.chat.android.models.Channel
+
+/**
+ * Result wrapper for [io.getstream.chat.android.client.api.ChatApi.queryChannels].
+ * Holds both the list of channels and the optional parsed predefined filter returned by the backend.
+ *
+ * @param channels The list of channels returned by the query.
+ * @param predefinedFilter The parsed predefined filter metadata, or null if a regular filter was used.
+ */
+@InternalStreamChatApi
+public data class QueryChannelsResult(
+    val channels: List<Channel>,
+    val predefinedFilter: PredefinedFilter?,
+)