Enables slow mode for the channel. When slow mode is enabled, users can only send a message every cooldownTimeInSeconds time interval. The cooldownTimeInSeconds is specified in seconds, and should be between 1-120.

get

fun get(messageLimit: Int = 0, memberLimit: Int = 0, state: Boolean = false): Call<Channel>

Gets the channel.

getFileAttachments

@CheckResult

fun getFileAttachments(offset: Int, limit: Int): Call<List<Attachment>>

getImageAttachments

@CheckResult

fun getImageAttachments(offset: Int, limit: Int): Call<List<Attachment>>

getMessage

@CheckResult

fun getMessage(messageId: String): Call<Message>

getMessagesWithAttachments

@CheckResult

fun getMessagesWithAttachments(offset: Int, limit: Int, types: List<String>): Call<List<Message>>

Returns a Call with messages that contain at least one desired type attachment but not necessarily all of them will have a specified type.

getPinnedMessages

@CheckResult

fun getPinnedMessages(limit: Int, sort: QuerySorter<Message>, pagination: PinnedMessagesPagination): Call<List<Message>>

Returns a list of messages pinned in the channel. You can sort the list by specifying sort parameter. Keep in mind that for now we only support sorting by Message.pinnedAt. The list can be paginated in a few different ways using limit and pagination.

getReactions

@CheckResult

fun getReactions(messageId: String, offset: Int, limit: Int): Call<List<Reaction>>

@CheckResult

fun getReactions(messageId: String, firstReactionId: String, limit: Int): Call<List<Message>>

hide

@CheckResult

fun hide(clearHistory: Boolean = false): Call<Unit>

Hides the channel.

inviteMembers

@CheckResult

fun inviteMembers(memberIds: List<String>, systemMessage: Message? = null, skipPush: Boolean? = null): Call<Channel>

Invites members to a given channel.

keystroke

@CheckResult

@JvmOverloads

fun keystroke(parentId: String? = null): Call<ChatEvent>

Sends a start typing event EventType.TYPING_START in this channel to the server.

markMessageRead

@CheckResult

fun markMessageRead(messageId: String): Call<Unit>

markRead

@CheckResult

fun markRead(): Call<Unit>

markThreadRead

@CheckResult

fun markThreadRead(threadId: String): Call<Unit>

Marks a given thread in the channel as read.

markThreadUnread

@CheckResult

fun markThreadUnread(threadId: String, messageId: String): Call<Unit>

Marks a given thread in the channel starting from the given message as unread.

markUnread

@CheckResult

fun markUnread(messageId: String): Call<Unit>

mute

@JvmOverloads

@CheckResult

fun mute(expiration: Int? = null): Call<Unit>

Mutes a channel for the current user. Messages added to the channel will not trigger push notifications, and will not change the unread count for the users that muted it. By default, mutes stay in place indefinitely until the user removes it. However, you can optionally set an expiration time. Triggers notification.channel_mutes_updated event.

muteCurrentUser

@CheckResult

fun muteCurrentUser(): Call<Mute>

muteUser

@JvmOverloads

@CheckResult

fun muteUser(userId: String, timeout: Int? = null): Call<Mute>

Mutes a user. Messages from muted users will not trigger push notifications. By default, mutes stay in place indefinitely until the user removes it. However, you can optionally set a mute timeout. Triggers notification.mutes_updated event.

partialUpdateMember

@CheckResult

fun partialUpdateMember(userId: String, set: Map<String, Any> = emptyMap(), unset: List<String> = emptyList()): Call<Member>

Updates specific fields of custom data for a given member.

@CheckResult

fun pin(): Call<Member>

Pins the channel for the current user.

pinMessage

@CheckResult

fun pinMessage(message: Message, expirationDate: Date?): Call<Message>

@CheckResult

fun pinMessage(message: Message, timeout: Int): Call<Message>

query

@CheckResult

fun query(request: QueryChannelRequest): Call<Channel>

queryBannedUsers

@CheckResult

@JvmOverloads

fun queryBannedUsers(filter: FilterObject? = null, sort: QuerySorter<BannedUsersSort> = QuerySortByField.ascByName("created_at"), offset: Int? = null, limit: Int? = null, createdAtAfter: Date? = null, createdAtAfterOrEqual: Date? = null, createdAtBefore: Date? = null, createdAtBeforeOrEqual: Date? = null): Call<List<BannedUser>>

queryMembers

@CheckResult

fun queryMembers(offset: Int, limit: Int, filter: FilterObject, sort: QuerySorter<Member>, members: List<Member> = emptyList()): Call<List<Member>>

Queries members for this channel.

rejectInvite

@CheckResult

fun rejectInvite(): Call<Channel>

removeMembers

@CheckResult

fun removeMembers(memberIds: List<String>, systemMessage: Message? = null, skipPush: Boolean? = null): Call<Channel>

Removes members from a given channel.

removeShadowBan

@CheckResult

fun removeShadowBan(targetId: String): Call<Unit>

sendAction

@CheckResult

fun sendAction(request: SendActionRequest): Call<Message>

sendEvent

@CheckResult

fun sendEvent(eventType: String, extraData: Map<Any, Any> = emptyMap()): Call<ChatEvent>

Sends an event to all users watching the channel.

sendFile

@CheckResult

@JvmOverloads

fun sendFile(file: File, callback: ProgressCallback? = null): Call<UploadedFile>

Uploads a file for the given channel. Progress can be accessed via callback.

sendImage

@CheckResult

@JvmOverloads

fun sendImage(file: File, callback: ProgressCallback? = null): Call<UploadedFile>

Uploads an image for the given channel. Progress can be accessed via callback.

sendMessage

@CheckResult

@JvmOverloads

fun sendMessage(message: Message, isRetrying: Boolean = false): Call<Message>

Sends the message to the given channel with side effects if there is any plugin added in the client.

sendReaction

@CheckResult

fun sendReaction(reaction: Reaction, enforceUnique: Boolean = false): Call<Reaction>

Sends the reaction. Use enforceUnique parameter to specify whether the reaction should replace other reactions added by the current user.

shadowBanUser

@CheckResult

fun shadowBanUser(targetId: String, reason: String?, timeout: Int?): Call<Unit>

show

@CheckResult

fun show(): Call<Unit>

stopTyping

@CheckResult

@JvmOverloads

fun stopTyping(parentId: String? = null): Call<ChatEvent>

Sends a stop typing event EventType.TYPING_STOP in this channel to the server.

stopWatching

@CheckResult

fun stopWatching(): Call<Unit>

fun subscribe(listener: ChatEventListener<ChatEvent>): Disposable

subscribeFor

fun subscribeFor(vararg eventTypes: Class<out ChatEvent>, listener: ChatEventListener<ChatEvent>): Disposable

fun subscribeFor(vararg eventTypes: String, listener: ChatEventListener<ChatEvent>): Disposable

fun subscribeFor(lifecycleOwner: LifecycleOwner, vararg eventTypes: Class<out ChatEvent>, listener: ChatEventListener<ChatEvent>): Disposable

fun subscribeFor(lifecycleOwner: LifecycleOwner, vararg eventTypes: String, listener: ChatEventListener<ChatEvent>): Disposable

subscribeForSingle

fun <T : ChatEvent> subscribeForSingle(eventType: Class<T>, listener: ChatEventListener<T>): Disposable

fun subscribeForSingle(eventType: String, listener: ChatEventListener<ChatEvent>): Disposable

truncate

@CheckResult

@JvmOverloads

fun truncate(systemMessage: Message? = null): Call<Channel>

Removes all of the messages of the channel but doesn't affect the channel data or members.

unarchive

@CheckResult

fun unarchive(): Call<Member>

Un-archives the channel for the current user.

unbanUser

@CheckResult

fun unbanUser(targetId: String): Call<Unit>

unmute

@CheckResult

fun unmute(): Call<Unit>

Unmutes a channel for the current user. Triggers notification.channel_mutes_updated event.

unmuteCurrentUser

@CheckResult

fun unmuteCurrentUser(): Call<Unit>

unmuteUser

@CheckResult

fun unmuteUser(userId: String): Call<Unit>

Unmutes a previously muted user. Triggers notification.mutes_updated event.

unpin

@CheckResult

fun unpin(): Call<Member>

Unpins the channel for the current user.

unpinMessage

@CheckResult

fun unpinMessage(message: Message): Call<Message>

update

@CheckResult

fun update(message: Message? = null, extraData: Map<String, Any> = emptyMap()): Call<Channel>

Updates all of the channel data. Any data that is present on the channel and not included in a full update will be deleted.

updateMessage

@CheckResult

fun updateMessage(message: Message): Call<Message>

updatePartial

@CheckResult

fun updatePartial(set: Map<String, Any> = emptyMap(), unset: List<String> = emptyList()): Call<Channel>

Updates specific fields of channel data retaining the custom data fields which were set previously.

watch

@CheckResult

fun watch(): Call<Channel>

@CheckResult

fun watch(request: WatchChannelRequest): Call<Channel>

@CheckResult

fun watch(data: Map<String, Any>): Call<Channel>

Inherited functions

subscribeFor

inline fun <T : ChatEvent> ChannelClient.subscribeFor(listener: ChatEventListener<T>): Disposable

Subscribes to events of type T in the channel.

inline fun <T : ChatEvent> ChannelClient.subscribeFor(lifecycleOwner: LifecycleOwner, listener: ChatEventListener<T>): Disposable

Subscribes to events of type T in the channel, in the lifecycle of lifecycleOwner.

fun ChannelClient.subscribeFor(vararg eventTypes: KClass<out ChatEvent>, listener: ChatEventListener<ChatEvent>): Disposable

Subscribes to the specific eventTypes of the channel.

fun ChannelClient.subscribeFor(lifecycleOwner: LifecycleOwner, vararg eventTypes: KClass<out ChatEvent>, listener: ChatEventListener<ChatEvent>): Disposable

Subscribes to the specific eventTypes of the channel, in the lifecycle of lifecycleOwner.

subscribeForSingle

inline fun <T : ChatEvent> ChannelClient.subscribeForSingle(listener: ChatEventListener<T>): Disposable

Subscribes for the next channel event of type T.