
public final class ChannelClient

Client for performing actions related to a specific channel.

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`cid`
`private final String`	`channelType`
`private final String`	`channelId`

Method Summary

Modifier and Type	Method	Description
`final String`	`getCid()`	The channel id in the format of `channelType:channelId`.
`final String`	`getChannelType()`
`final String`	`getChannelId()`
`final Call<Channel>`	`get(Integer messageLimit, Integer memberLimit, Boolean state)`	Gets the channel.
`final Call<Channel>`	`create(List<String> memberIds, Map<String, Object> extraData)`	Creates the id-based channel.
`final Call<Channel>`	`create(CreateChannelParams params)`	Creates the id-based channel.
`final Disposable`	`subscribe(ChatEventListener<ChatEvent> listener)`
`final Disposable`	`subscribeFor(String eventTypes, ChatEventListener<ChatEvent> listener)`
`final Disposable`	`subscribeFor(LifecycleOwner lifecycleOwner, String eventTypes, ChatEventListener<ChatEvent> listener)`
`final Disposable`	`subscribeFor(Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)`
`final Disposable`	`subscribeFor(LifecycleOwner lifecycleOwner, Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)`
`final Disposable`	`subscribeForSingle(String eventType, ChatEventListener<ChatEvent> listener)`
`final <T extends ChatEvent> Disposable`	`subscribeForSingle(Class<T> eventType, ChatEventListener<T> listener)`
`final Call<Channel>`	`query(QueryChannelRequest request)`
`final Call<Channel>`	`watch(WatchChannelRequest request)`
`final Call<Channel>`	`watch(Map<String, Object> data)`
`final Call<Channel>`	`watch()`
`final Call<Unit>`	`stopWatching()`
`final Call<Message>`	`getMessage(String messageId)`
`final Call<Message>`	`updateMessage(Message message)`
`final Call<Message>`	`deleteMessage(String messageId, Boolean hard)`
`final Call<Message>`	`deleteMessage(String messageId)`
`final Call<Message>`	`sendMessage(Message message, Boolean isRetrying)`	Sends the message to the given channel with side effects if there is any plugin added in the client.
`final Call<Message>`	`sendMessage(Message message)`	Sends the message to the given channel with side effects if there is any plugin added in the client.
`final Call<Unit>`	`banUser(String targetId, String reason, Integer timeout)`
`final Call<Unit>`	`unbanUser(String targetId)`
`final Call<Unit>`	`shadowBanUser(String targetId, String reason, Integer timeout)`
`final Call<Unit>`	`removeShadowBan(String targetId)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore, Date createdAtBeforeOrEqual)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort)`
`final Call<List<BannedUser>>`	`queryBannedUsers(FilterObject filter)`
`final Call<List<BannedUser>>`	`queryBannedUsers()`
`final Call<Unit>`	`markMessageRead(String messageId)`
`final Call<Unit>`	`markThreadRead(String threadId)`	Marks a given thread in the channel as read.
`final Call<Unit>`	`markUnread(String messageId)`
`final Call<Unit>`	`markUnread(Date timestamp)`	Marks all messages in the channel as unread that were created after the specified timestamp.
`final Call<Unit>`	`markThreadUnread(String threadId)`	Marks a given thread in the channel as unread.
`final Call<Unit>`	`markRead()`
`final Call<Channel>`	`delete()`
`final Call<Unit>`	`show()`
`final Call<Unit>`	`hide(Boolean clearHistory)`	Hides the channel.
`final Call<Channel>`	`truncate(Message systemMessage)`	Removes all of the messages of the channel but doesn't affect the channel data or members.
`final Call<Channel>`	`truncate()`	Removes all of the messages of the channel but doesn't affect the channel data or members.
`final Call<UploadedFile>`	`sendFile(File file, ProgressCallback callback)`	Uploads a file for the given channel.
`final Call<UploadedFile>`	`sendFile(File file)`	Uploads a file for the given channel.
`final Call<UploadedFile>`	`sendImage(File file, ProgressCallback callback)`	Uploads an image for the given channel.
`final Call<UploadedFile>`	`sendImage(File file)`	Uploads an image for the given channel.
`final Call<Unit>`	`deleteFile(String url)`	Deletes the file represented by url from the given channel.
`final Call<Unit>`	`deleteImage(String url)`	Deletes the image represented by url from the given channel.
`final Call<Reaction>`	`sendReaction(Reaction reaction, Boolean enforceUnique, Boolean skipPush)`	Sends the reaction.
`final Call<Reaction>`	`sendReaction(Reaction reaction, Boolean enforceUnique)`	Sends the reaction.
`final Call<Reaction>`	`sendReaction(Reaction reaction)`	Sends the reaction.
`final Call<Message>`	`sendAction(SendActionRequest request)`
`final Call<Message>`	`deleteReaction(String messageId, String reactionType)`	Deletes the reaction associated with the message with the given message id.
`final Call<List<Reaction>>`	`getReactions(String messageId, Integer offset, Integer limit)`
`final Call<Channel>`	`update(Message message, Map<String, Object> extraData)`	Updates all of the channel data.
`final Call<Channel>`	`updatePartial(Map<String, Object> set, List<String> unset)`	Updates specific fields of channel data retaining the custom data fields which were set previously.
`final Call<Member>`	`partialUpdateMember(String userId, Map<String, Object> set, List<String> unset)`	Updates specific fields of custom data for a given member.
`final Call<Channel>`	`enableSlowMode(Integer cooldownTimeInSeconds)`	Enables slow mode for the channel.
`final Call<Channel>`	`disableSlowMode()`	Disables slow mode for the channel.
`final Call<Channel>`	`addMembers(List<String> memberIds, Message systemMessage, Boolean hideHistory, Date hideHistoryBefore, Boolean skipPush)`	Adds members to a given channel.
`final Call<Channel>`	`addMembers(AddMembersParams params)`	Adds members with extra data to a given channel.
`final Call<Channel>`	`removeMembers(List<String> memberIds, Message systemMessage, Boolean skipPush)`	Removes members from a given channel.
`final Call<Channel>`	`inviteMembers(List<String> memberIds, Message systemMessage, Boolean skipPush)`	Invites members to a given channel.
`final Call<Channel>`	`acceptInvite(String message)`
`final Call<Channel>`	`rejectInvite()`
`final Call<Unit>`	`mute(Integer expiration)`	Mutes a channel for the current user.
`final Call<Unit>`	`mute()`	Mutes a channel for the current user.
`final Call<Unit>`	`unmute()`	Unmutes a channel for the current user.
`final Call<Mute>`	`muteUser(String userId, Integer timeout)`	Mutes a user.
`final Call<Mute>`	`muteUser(String userId)`	Mutes a user.
`final Call<Unit>`	`unmuteUser(String userId)`	Unmutes a previously muted user.
`final Call<Mute>`	`muteCurrentUser()`
`final Call<Unit>`	`unmuteCurrentUser()`
`final Call<ChatEvent>`	`keystroke(String parentId)`	Sends a start typing event EventType.TYPING_START in this channel to the server.
`final Call<ChatEvent>`	`keystroke()`	Sends a start typing event EventType.TYPING_START in this channel to the server.
`final Call<ChatEvent>`	`stopTyping(String parentId)`	Sends a stop typing event EventType.TYPING_STOP in this channel to the server.
`final Call<ChatEvent>`	`stopTyping()`	Sends a stop typing event EventType.TYPING_STOP in this channel to the server.
`final Call<ChatEvent>`	`sendEvent(String eventType, Map<Object, Object> extraData)`	Sends an event to all users watching the channel.
`final Call<List<Member>>`	`queryMembers(Integer offset, Integer limit, FilterObject filter, QuerySorter<Member> sort, List<Member> members)`	Queries members for this channel.
`final Call<List<Attachment>>`	`getFileAttachments(Integer offset, Integer limit)`
`final Call<List<Attachment>>`	`getImageAttachments(Integer offset, Integer limit)`
`final Call<List<Message>>`	`getMessagesWithAttachments(Integer offset, Integer limit, List<String> types)`	Returns a Call with messages that contain at least one desired type attachment but not necessarily all of them will have a specified type.
`final Call<List<Message>>`	`getPinnedMessages(Integer limit, QuerySorter<Message> sort, PinnedMessagesPagination pagination)`	Returns a list of messages pinned in the channel.
`final Call<Message>`	`pinMessage(Message message, Date expirationDate)`
`final Call<Message>`	`pinMessage(Message message, Integer timeout)`
`final Call<Message>`	`unpinMessage(Message message)`
`final Call<Member>`	`pin()`	Pins the channel for the current user.
`final Call<Member>`	`unpin()`	Unpins the channel for the current user.
`final Call<Member>`	`archive()`	Archives the channel for the current user.
`final Call<Member>`	`unarchive()`	Un-archives the channel for the current user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getCid
```
 final String getCid()
```
    The channel id in the format of channelType:channelId.
  - getChannelType
```
 final String getChannelType()
```
  - getChannelId
```
 final String getChannelId()
```
  - get
```
 final Call<Channel> get(Integer messageLimit, Integer memberLimit, Boolean state)
```
    Gets the channel.
    
    Parameters:
    
    messageLimit - The number of messages to retrieve.
    
    memberLimit - The number of members to retrieve.
    
    state - Whether to retrieve the channel state or not.
  - create
```
@CheckResult() final Call<Channel> create(List<String> memberIds, Map<String, Object> extraData)
```
    Creates the id-based channel.
    
    Parameters:
    
    memberIds - The list of members' ids.
    
    extraData - Map of key-value pairs that let you store extra data
  - create
```
@CheckResult() final Call<Channel> create(CreateChannelParams params)
```
    Creates the id-based channel.
    
    Parameters:
    
    params - The CreateChannelParams holding the data required for creating a channel.
  - subscribe
```
 final Disposable subscribe(ChatEventListener<ChatEvent> listener)
```
  - subscribeFor
```
 final Disposable subscribeFor(String eventTypes, ChatEventListener<ChatEvent> listener)
```
  - subscribeFor
```
 final Disposable subscribeFor(LifecycleOwner lifecycleOwner, String eventTypes, ChatEventListener<ChatEvent> listener)
```
  - subscribeFor
```
 final Disposable subscribeFor(Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)
```
  - subscribeFor
```
 final Disposable subscribeFor(LifecycleOwner lifecycleOwner, Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)
```
  - subscribeForSingle
```
 final Disposable subscribeForSingle(String eventType, ChatEventListener<ChatEvent> listener)
```
  - subscribeForSingle
```
 final <T extends ChatEvent> Disposable subscribeForSingle(Class<T> eventType, ChatEventListener<T> listener)
```
  - query
```
@CheckResult() final Call<Channel> query(QueryChannelRequest request)
```
  - watch
```
@CheckResult() final Call<Channel> watch(WatchChannelRequest request)
```
  - watch
```
@CheckResult() final Call<Channel> watch(Map<String, Object> data)
```
  - watch
```
@CheckResult() final Call<Channel> watch()
```
  - stopWatching
```
@CheckResult() final Call<Unit> stopWatching()
```
  - getMessage
```
@CheckResult() final Call<Message> getMessage(String messageId)
```
  - updateMessage
```
@CheckResult() final Call<Message> updateMessage(Message message)
```
  - deleteMessage
```
@CheckResult()@JvmOverloads() final Call<Message> deleteMessage(String messageId, Boolean hard)
```
  - deleteMessage
```
@CheckResult()@JvmOverloads() final Call<Message> deleteMessage(String messageId)
```
  - sendMessage
```
@CheckResult()@JvmOverloads() final Call<Message> sendMessage(Message message, Boolean isRetrying)
```
    Sends the message to the given channel with side effects if there is any plugin added in the client.
    
    Parameters:
    
    message - Message to send.
    
    isRetrying - True if this message is being retried.
  - sendMessage
```
@CheckResult()@JvmOverloads() final Call<Message> sendMessage(Message message)
```
    Sends the message to the given channel with side effects if there is any plugin added in the client.
    
    Parameters:
    
    message - Message to send.
  - banUser
```
@CheckResult() final Call<Unit> banUser(String targetId, String reason, Integer timeout)
```
  - unbanUser
```
@CheckResult() final Call<Unit> unbanUser(String targetId)
```
  - shadowBanUser
```
@CheckResult() final Call<Unit> shadowBanUser(String targetId, String reason, Integer timeout)
```
  - removeShadowBan
```
@CheckResult() final Call<Unit> removeShadowBan(String targetId)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore, Date createdAtBeforeOrEqual)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset, Integer limit)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort, Integer offset)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySorter<BannedUsersSort> sort)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers(FilterObject filter)
```
  - queryBannedUsers
```
@CheckResult()@JvmOverloads() final Call<List<BannedUser>> queryBannedUsers()
```
  - markMessageRead
```
@CheckResult() final Call<Unit> markMessageRead(String messageId)
```
  - markThreadRead
```
@CheckResult() final Call<Unit> markThreadRead(String threadId)
```
    Marks a given thread in the channel as read.
    
    Parameters:
    
    threadId - The ID of the thread to mark as read.
  - markUnread
```
@CheckResult() final Call<Unit> markUnread(String messageId)
```
  - markUnread
```
@CheckResult() final Call<Unit> markUnread(Date timestamp)
```
    Marks all messages in the channel as unread that were created after the specified timestamp.
    
    Parameters:
    
    timestamp - The timestamp used to find the first message to mark as unread.
  - markThreadUnread
```
@CheckResult() final Call<Unit> markThreadUnread(String threadId)
```
    Marks a given thread in the channel as unread.
    
    Parameters:
    
    threadId - Id of the thread to mark as unread.
  - markRead
```
@CheckResult() final Call<Unit> markRead()
```
  - delete
```
@CheckResult() final Call<Channel> delete()
```
  - show
```
@CheckResult() final Call<Unit> show()
```
  - hide
```
@CheckResult() final Call<Unit> hide(Boolean clearHistory)
```
    Hides the channel.
    
    Parameters:
    
    clearHistory - Boolean, if you want to clear the history of this channel or not.
  - truncate
```
@CheckResult()@JvmOverloads() final Call<Channel> truncate(Message systemMessage)
```
    Removes all of the messages of the channel but doesn't affect the channel data or members.
    
    Parameters:
    
    systemMessage - The system message object that will be shown in the channel.
  - truncate
```
@CheckResult()@JvmOverloads() final Call<Channel> truncate()
```
    Removes all of the messages of the channel but doesn't affect the channel data or members.
  - sendFile
```
@CheckResult()@JvmOverloads() final Call<UploadedFile> sendFile(File file, ProgressCallback callback)
```
    Uploads a file for the given channel. Progress can be accessed via callback.
    The Stream CDN imposes the following restrictions on file uploads:
    The maximum file size is 100 MB
    Parameters:
    
    file - The file that needs to be uploaded.
    
    callback - The callback to track progress.
  - sendFile
```
@CheckResult()@JvmOverloads() final Call<UploadedFile> sendFile(File file)
```
    Uploads a file for the given channel. Progress can be accessed via callback.
    The Stream CDN imposes the following restrictions on file uploads:
    The maximum file size is 100 MB
    Parameters:
    
    file - The file that needs to be uploaded.
  - sendImage
```
@CheckResult()@JvmOverloads() final Call<UploadedFile> sendImage(File file, ProgressCallback callback)
```
    Uploads an image for the given channel. Progress can be accessed via callback.
    The Stream CDN imposes the following restrictions on image uploads:
    The maximum image size is 100 MB
    Supported MIME types are listed in StreamCdnImageMimeTypes.SUPPORTED_IMAGE_MIME_TYPES
    Parameters:
    
    file - The image file that needs to be uploaded.
    
    callback - The callback to track progress.
  - sendImage
```
@CheckResult()@JvmOverloads() final Call<UploadedFile> sendImage(File file)
```
    Uploads an image for the given channel. Progress can be accessed via callback.
    The Stream CDN imposes the following restrictions on image uploads:
    The maximum image size is 100 MB
    Supported MIME types are listed in StreamCdnImageMimeTypes.SUPPORTED_IMAGE_MIME_TYPES
    Parameters:
    
    file - The image file that needs to be uploaded.
  - deleteFile
```
@CheckResult() final Call<Unit> deleteFile(String url)
```
    Deletes the file represented by url from the given channel.
    
    Parameters:
    
    url - The URL of the file to be deleted.
  - deleteImage
```
@CheckResult() final Call<Unit> deleteImage(String url)
```
    Deletes the image represented by url from the given channel.
    
    Parameters:
    
    url - The URL of the image to be deleted.
  - sendReaction
```
@CheckResult()@JvmOverloads() final Call<Reaction> sendReaction(Reaction reaction, Boolean enforceUnique, Boolean skipPush)
```
    Sends the reaction. Use enforceUnique parameter to specify whether the reaction should replace other reactions added by the current user.
    
    Parameters:
    
    reaction - The Reaction to send.
    
    enforceUnique - Flag to determine whether the reaction should replace other ones added by the current user.
    
    skipPush - If set to "true", skips sending push notification when reacting to a message.
  - sendReaction
```
@CheckResult()@JvmOverloads() final Call<Reaction> sendReaction(Reaction reaction, Boolean enforceUnique)
```
    Sends the reaction. Use enforceUnique parameter to specify whether the reaction should replace other reactions added by the current user.
    
    Parameters:
    
    reaction - The Reaction to send.
    
    enforceUnique - Flag to determine whether the reaction should replace other ones added by the current user.
  - sendReaction
```
@CheckResult()@JvmOverloads() final Call<Reaction> sendReaction(Reaction reaction)
```
    Sends the reaction. Use enforceUnique parameter to specify whether the reaction should replace other reactions added by the current user.
    
    Parameters:
    
    reaction - The Reaction to send.
  - sendAction
```
@CheckResult() final Call<Message> sendAction(SendActionRequest request)
```
  - deleteReaction
```
@CheckResult() final Call<Message> deleteReaction(String messageId, String reactionType)
```
    Deletes the reaction associated with the message with the given message id.
    
    Parameters:
    
    messageId - The id of the message to which reaction belongs.
    
    reactionType - The type of reaction.
  - getReactions
```
@CheckResult() final Call<List<Reaction>> getReactions(String messageId, Integer offset, Integer limit)
```
  - update
```
@CheckResult() final Call<Channel> update(Message message, Map<String, Object> extraData)
```
    Updates all of the channel data. Any data that is present on the channel and not included in a full update will be deleted.
    
    Parameters:
    
    message - The message object allowing you to show a system message in the channel.
    
    extraData - The updated channel extra data.
  - updatePartial
```
@CheckResult() final Call<Channel> updatePartial(Map<String, Object> set, List<String> unset)
```
    Updates specific fields of channel data retaining the custom data fields which were set previously.
    
    Parameters:
    
    set - The key-value data which will be added to the existing channel data object.
    
    unset - The list of fields which will be removed from the existing channel data object.
  - partialUpdateMember
```
@CheckResult() final Call<Member> partialUpdateMember(String userId, Map<String, Object> set, List<String> unset)
```
    Updates specific fields of custom data for a given member.
    
    Parameters:
    
    userId - The user id of the member to update.
    
    set - The key-value data to be updated in the member data.
    
    unset - The list of keys to be removed from the member data.
  - enableSlowMode
```
@CheckResult() final Call<Channel> enableSlowMode(Integer cooldownTimeInSeconds)
```
    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.
    
    Parameters:
    
    cooldownTimeInSeconds - The duration of the time interval users have to wait between messages.
  - disableSlowMode
```
@CheckResult() final Call<Channel> disableSlowMode()
```
    Disables slow mode for the channel.
  - addMembers
```
@CheckResult() final Call<Channel> addMembers(List<String> memberIds, Message systemMessage, Boolean hideHistory, Date hideHistoryBefore, Boolean skipPush)
```
    Adds members to a given channel.
    
    Parameters:
    
    memberIds - The list of the member ids to be added.
    
    systemMessage - The system message object that will be shown in the channel.
    
    hideHistory - Hides the history of the channel to the added member.
    
    hideHistoryBefore - Hides the channel history before the provided date from the added members.
    
    skipPush - Skip sending push notifications.
  - addMembers
```
@CheckResult() final Call<Channel> addMembers(AddMembersParams params)
```
    Adds members with extra data to a given channel.
    
    Parameters:
    
    params - The AddMembersParams holding data about the members to be added.
  - removeMembers
```
@CheckResult() final Call<Channel> removeMembers(List<String> memberIds, Message systemMessage, Boolean skipPush)
```
    Removes members from a given channel.
    
    Parameters:
    
    memberIds - The list of the member ids to be removed.
    
    systemMessage - The system message object that will be shown in the channel.
    
    skipPush - Skip sending push notifications.
  - inviteMembers
```
@CheckResult() final Call<Channel> inviteMembers(List<String> memberIds, Message systemMessage, Boolean skipPush)
```
    Invites members to a given channel.
    
    Parameters:
    
    memberIds - The list of the member ids to be invited.
    
    systemMessage - The system message object that will be shown in the channel.
    
    skipPush - Skip sending push notifications.
  - acceptInvite
```
@CheckResult() final Call<Channel> acceptInvite(String message)
```
  - rejectInvite
```
@CheckResult() final Call<Channel> rejectInvite()
```
  - mute
```
@JvmOverloads()@CheckResult() final Call<Unit> mute(Integer expiration)
```
    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.
    
    Parameters:
    
    expiration - The duration of mute in millis.
  - mute
```
@JvmOverloads()@CheckResult() final Call<Unit> mute()
```
    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.
  - unmute
```
@CheckResult() final Call<Unit> unmute()
```
    Unmutes a channel for the current user. Triggers notification.channel_mutes_updated event.
  - muteUser
```
@JvmOverloads()@CheckResult() final Call<Mute> muteUser(String userId, Integer timeout)
```
    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.
    
    Parameters:
    
    userId - The user id to mute.
    
    timeout - The timeout in minutes until the mute is expired.
  - muteUser
```
@JvmOverloads()@CheckResult() final Call<Mute> muteUser(String userId)
```
    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.
    
    Parameters:
    
    userId - The user id to mute.
  - unmuteUser
```
@CheckResult() final Call<Unit> unmuteUser(String userId)
```
    Unmutes a previously muted user. Triggers notification.mutes_updated event.
    
    Parameters:
    
    userId - The user id to unmute.
  - muteCurrentUser
```
@CheckResult() final Call<Mute> muteCurrentUser()
```
  - unmuteCurrentUser
```
@CheckResult() final Call<Unit> unmuteCurrentUser()
```
  - keystroke
```
@CheckResult()@JvmOverloads() final Call<ChatEvent> keystroke(String parentId)
```
    Sends a start typing event EventType.TYPING_START in this channel to the server.
    
    Parameters:
    
    parentId - Set this field to message.id to indicate that typing event is happening in a thread.
  - keystroke
```
@CheckResult()@JvmOverloads() final Call<ChatEvent> keystroke()
```
    Sends a start typing event EventType.TYPING_START in this channel to the server.
  - stopTyping
```
@CheckResult()@JvmOverloads() final Call<ChatEvent> stopTyping(String parentId)
```
    Sends a stop typing event EventType.TYPING_STOP in this channel to the server.
    
    Parameters:
    
    parentId - Set this field to message.id to indicate that typing event is happening in a thread.
  - stopTyping
```
@CheckResult()@JvmOverloads() final Call<ChatEvent> stopTyping()
```
    Sends a stop typing event EventType.TYPING_STOP in this channel to the server.
  - sendEvent
```
@CheckResult() final Call<ChatEvent> sendEvent(String eventType, Map<Object, Object> extraData)
```
    Sends an event to all users watching the channel.
    
    Parameters:
    
    eventType - The event name.
    
    extraData - The event payload.
  - queryMembers
```
@CheckResult() final Call<List<Member>> queryMembers(Integer offset, Integer limit, FilterObject filter, QuerySorter<Member> sort, List<Member> members)
```
    Queries members for this channel.
    
    Parameters:
    
    offset - Offset limit.
    
    limit - Number of members to fetch.
    
    filter - FilterObject to filter members of certain type.
    
    sort - Sort the list of members.
    
    members - List of members to search in distinct channels.
  - getFileAttachments
```
@CheckResult() final Call<List<Attachment>> getFileAttachments(Integer offset, Integer limit)
```
  - getImageAttachments
```
@CheckResult() final Call<List<Attachment>> getImageAttachments(Integer offset, Integer limit)
```
  - getMessagesWithAttachments
```
@CheckResult() final Call<List<Message>> getMessagesWithAttachments(Integer offset, Integer limit, List<String> types)
```
    Returns a Call with messages that contain at least one desired type attachment but not necessarily all of them will have a specified type.
    
    Parameters:
    
    offset - The messages offset.
    
    limit - Max limit messages to be fetched.
    
    types - Desired attachment's types list.
  - getPinnedMessages
```
@CheckResult() final Call<List<Message>> getPinnedMessages(Integer limit, QuerySorter<Message> sort, PinnedMessagesPagination pagination)
```
    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.
    
    Parameters:
    
    limit - Max limit of messages to be fetched.
    
    sort - Parameter by which we sort the messages.
    
    pagination - Provides different options for pagination.
  - pinMessage
```
@CheckResult() final Call<Message> pinMessage(Message message, Date expirationDate)
```
  - pinMessage
```
@CheckResult() final Call<Message> pinMessage(Message message, Integer timeout)
```
  - unpinMessage
```
@CheckResult() final Call<Message> unpinMessage(Message message)
```
  - pin
```
@CheckResult() final Call<Member> pin()
```
    Pins the channel for the current user.
  - unpin
```
@CheckResult() final Call<Member> unpin()
```
    Unpins the channel for the current user.
  - archive
```
@CheckResult() final Call<Member> archive()
```
    Archives the channel for the current user.
  - unarchive
```
@CheckResult() final Call<Member> unarchive()
```
    Un-archives the channel for the current user.

Class ChannelClient

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCid

getChannelType

getChannelId

get

create

create

subscribe

subscribeFor

subscribeFor

subscribeFor

subscribeFor

subscribeForSingle

subscribeForSingle

query

watch

watch

watch

stopWatching

getMessage

updateMessage

deleteMessage

deleteMessage

sendMessage

sendMessage

banUser

unbanUser

shadowBanUser

removeShadowBan

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

queryBannedUsers

markMessageRead

markThreadRead

markUnread

markUnread

markThreadUnread

markRead

delete

show

hide

truncate

truncate

sendFile

sendFile

sendImage

sendImage

deleteFile

deleteImage

sendReaction

sendReaction

sendReaction

sendAction

deleteReaction

getReactions

update

updatePartial

partialUpdateMember

enableSlowMode

disableSlowMode

addMembers

addMembers

removeMembers

inviteMembers

acceptInvite

rejectInvite

mute

mute

unmute

muteUser