stream-chat-android-client/io.getstream.chat.android.client.api.models

Package-level declarations

Types

data class GetThreadOptions @JvmOverloads constructor(val watch: Boolean = true, val replyLimit: Int = 2, val participantLimit: Int = 100, val memberLimit: Int = 100)

Query threads request.

Pagination

enum Pagination : Enum<Pagination>

PinnedMessagesPagination

sealed class PinnedMessagesPagination

Pagination options for getting pinned messages.

PredefinedFilter

data class PredefinedFilter(val filter: FilterObject, val sort: QuerySorter<Channel>)

Represents a predefined filter parsed by the backend.

QueryChannelRequest

open class QueryChannelRequest : ChannelRequest<QueryChannelRequest>

QueryChannelsRequest

data class QueryChannelsRequest @JvmOverloads constructor(val filter: FilterObject, var offset: Int = 0, var limit: Int, val querySort: QuerySorter<Channel> = QuerySortByField(), var messageLimit: Int? = null, var memberLimit: Int? = null, val predefinedFilter: String? = null, val filterValues: Map<String, Any>? = null, val sortValues: Map<String, Any>? = null) : ChannelRequest<QueryChannelsRequest>

Request body class for querying channels.

QueryChannelsResult

data class QueryChannelsResult(val channels: List<Channel>, val predefinedFilter: PredefinedFilter?)

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.

QueryThreadsRequest

data class QueryThreadsRequest @JvmOverloads constructor(val filter: FilterObject? = null, val sort: QuerySorter<Thread> = DefaultSort, val watch: Boolean = true, val limit: Int = 10, val memberLimit: Int = 100, val next: String? = null, val participantLimit: Int = 100, val prev: String? = null, val replyLimit: Int = 2)

Query threads request.

QueryUsersRequest

data class QueryUsersRequest @JvmOverloads constructor(var filter: FilterObject, val offset: Int, val limit: Int, var querySort: QuerySorter<User> = QuerySortByField(), var presence: Boolean = false)

SearchMessagesRequest

data class SearchMessagesRequest @JvmOverloads constructor(val offset: Int?, val limit: Int?, val channelFilter: FilterObject, val messageFilter: FilterObject, val next: String? = null, val querySort: QuerySorter<Message>? = null)

SendActionRequest

data class SendActionRequest(val channelId: String, val messageId: String, val type: String, val formData: Map<Any, Any>)

UpdatePollRequest

data class UpdatePollRequest(val id: String, val name: String, val allowAnswers: Boolean? = null, val allowUserSuggestedOptions: Boolean? = null, val description: String? = null, val enforceUniqueVote: Boolean? = null, val isClosed: Boolean? = null, val maxVotesAllowed: Int? = null, val options: List<PollOption>? = null, val votingVisibility: VotingVisibility = VotingVisibility.PUBLIC, val extraData: Map<String, Any> = emptyMap())

Model holding request data for updating a poll.

WatchChannelRequest

class WatchChannelRequest : QueryChannelRequest