Method Detail

• getNotificationHandler

   final ChatNotificationHandler getNotificationHandler()

• getDisconnectListeners

   final List<Function1<User, Unit>> getDisconnectListeners()

• getPreSetUserListeners

   final List<Function1<User, Unit>> getPreSetUserListeners()

• getConfig

   final ChatClientConfig getConfig()

• connectUser

   final Call<ConnectionData> connectUser(User user, String token)

  Initializes ChatClient for a specific user using the given user token.

  Parameters:

  user - Instance of User type.

  token - Instance of JWT token.

• connectUser

   final Call<ConnectionData> connectUser(User user, TokenProvider tokenProvider)

  Initializes ChatClient for a specific user. The tokenProvider implementation is used for the initial token, and it's also invoked whenever the user's token has expired, to fetch a new token.

  This method performs required operations before connecting with the Stream API. Moreover, it warms up the connection, sets up notifications, and connects to the socket. You can use listener to get updates about socket connection.

  Parameters:

  user - the user to set

  tokenProvider - a TokenProvider implementation

• setUserWithoutConnectingIfNeeded

   final Unit setUserWithoutConnectingIfNeeded()

  Initializes ChatClient with stored user data. Caution: This method doesn't establish connection to the web socket, you should use connectUser instead.

  This method initializes ChatClient to allow the use of Stream REST API client. Moreover, it warms up the connection, and sets up notifications.

• containsStoredCredentials

   final Boolean containsStoredCredentials()

• connectAnonymousUser

   final Call<ConnectionData> connectAnonymousUser()

• connectGuestUser

   final Call<ConnectionData> connectGuestUser(String userId, String username)

• getGuestToken

   final Call<GuestUser> getGuestToken(String userId, String userName)

• queryMembers

   final Call<List<Member>> queryMembers(String channelType, String channelId, Integer offset, Integer limit, FilterObject filter, QuerySort<Member> sort, List<Member> members)

• sendFile

   final Call<String> sendFile(String channelType, String channelId, 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 20 MB

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  file - the file that needs to be uploaded

  callback - the callback to track progress

• sendFile

   final Call<String> sendFile(String channelType, String channelId, 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 20 MB

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  file - the file that needs to be uploaded

• sendImage

   final Call<String> sendImage(String channelType, String channelId, 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 20 MB

  • Supported MIME types are listed in StreamCdnImageMimeTypes.SUPPORTED_IMAGE_MIME_TYPES

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  file - the image file that needs to be uploaded

  callback - the callback to track progress

• sendImage

   final Call<String> sendImage(String channelType, String channelId, 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 20 MB

  • Supported MIME types are listed in StreamCdnImageMimeTypes.SUPPORTED_IMAGE_MIME_TYPES

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  file - the image file that needs to be uploaded

• deleteFile

   final Call<Unit> deleteFile(String channelType, String channelId, String url)

  Deletes the file represented by url from the given channel.

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  url - the URL of the file to be deleted

• deleteImage

   final Call<Unit> deleteImage(String channelType, String channelId, String url)

  Deletes the image represented by url from the given channel.

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  url - the URL of the image to be deleted

• getReactions

   final Call<List<Reaction>> getReactions(String messageId, Integer offset, Integer limit)

• sendReaction

   final Call<Reaction> sendReaction(String messageId, String reactionType, Boolean enforceUnique)

• sendReaction

   final Call<Reaction> sendReaction(String messageId, String reactionType)

• sendReaction

   final Call<Reaction> sendReaction(Reaction reaction, Boolean enforceUnique)

• sendReaction

   final Call<Reaction> sendReaction(Reaction reaction)

• deleteReaction

   final Call<Message> deleteReaction(String messageId, String reactionType)

• disconnectSocket

   final Unit disconnectSocket()

• reconnectSocket

   final Unit reconnectSocket()

• addSocketListener

   final Unit addSocketListener(SocketListener listener)

• removeSocketListener

   final Unit removeSocketListener(SocketListener listener)

• subscribe

   final Disposable subscribe(ChatEventListener<ChatEvent> listener)

• subscribeFor

   final Disposable subscribeFor(String eventTypes, ChatEventListener<ChatEvent> listener)

  Subscribes to the specific eventTypes of the client.

• subscribeFor

   final Disposable subscribeFor(LifecycleOwner lifecycleOwner, String eventTypes, ChatEventListener<ChatEvent> listener)

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

  Only receives events when the lifecycle is in a STARTED state, otherwise events are dropped.

• subscribeFor

   final Disposable subscribeFor(Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)

  Subscribes to the specific eventTypes of the client.

• subscribeFor

   final Disposable subscribeFor(LifecycleOwner lifecycleOwner, Class<out ChatEvent> eventTypes, ChatEventListener<ChatEvent> listener)

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

  Only receives events when the lifecycle is in a STARTED state, otherwise events are dropped.

• subscribeForSingle

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

  Subscribes for the next event with the given eventType.

• subscribeForSingle

   final <T extends ChatEvent> Disposable subscribeForSingle(Class<T> eventType, ChatEventListener<T> listener)

  Subscribes for the next event with the given eventType.

• disconnect

   final Unit disconnect()

• getDevices

   final Call<List<Device>> getDevices()

• deleteDevice

   final Call<Unit> deleteDevice(Device device)

• addDevice

   final Call<Unit> addDevice(Device device)

• searchMessages

   final Call<List<Message>> searchMessages(SearchMessagesRequest request)

• getFileAttachments

   final Call<List<Attachment>> getFileAttachments(String channelType, String channelId, Integer offset, Integer limit)

• getImageAttachments

   final Call<List<Attachment>> getImageAttachments(String channelType, String channelId, Integer offset, Integer limit)

• getMessagesWithAttachments

   final Call<List<Message>> getMessagesWithAttachments(String channelType, String channelId, Integer offset, Integer limit, String type)

  Returns a Call<List<Message>> With messages which contain at least one desired type attachment but not necessarily all of them will have a specified type

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  offset - The messages offset

  limit - max limit messages to be fetched

  type - The desired type attachment

• getMessagesWithAttachments

   final Call<List<Message>> getMessagesWithAttachments(String channelType, String channelId, 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:

  channelType - the channel type.

  channelId - the channel id.

  offset - the messages offset

  limit - max limit messages to be fetched

  types - desired attachment's types list

• getReplies

   final Call<List<Message>> getReplies(String messageId, Integer limit)

• getRepliesMore

   final Call<List<Message>> getRepliesMore(String messageId, String firstId, Integer limit)

• sendAction

   final Call<Message> sendAction(SendActionRequest request)

• deleteMessage

   final Call<Message> deleteMessage(String messageId)

• getMessage

   final Call<Message> getMessage(String messageId)

• sendMessage

   final Call<Message> sendMessage(String channelType, String channelId, Message message)

• updateMessage

   final Call<Message> updateMessage(Message message)

• partialUpdateMessage

   final Call<Message> partialUpdateMessage(String messageId, Map<String, Object> set, List<String> unset)

  Partially updates specific Message fields retaining the fields which were set previously.

  Parameters:

  messageId - the message ID

  set - the key-value data which will be added to the existing message object

  unset - the list of fields which will be removed from the existing message object

• pinMessage

   final Call<Message> pinMessage(Message message, Date expirationDate)

  Pins the message

  Parameters:

  message - the message object containing the ID of the message to be pinned

  expirationDate - the exact expiration date

• pinMessage

   final Call<Message> pinMessage(Message message, Integer timeout)

  Pins the message

  Parameters:

  message - the message object containing the ID of the message to be pinned

  timeout - the expiration timeout in seconds

• unpinMessage

   final Call<Message> unpinMessage(Message message)

  Unpins the message that was previously pinned

  Parameters:

  message - the message object containing the ID of the message to be unpinned

• queryChannel

   final Call<Channel> queryChannel(String channelType, String channelId, QueryChannelRequest request)

• queryChannels

   final Call<List<Channel>> queryChannels(QueryChannelsRequest request)

• deleteChannel

   final Call<Channel> deleteChannel(String channelType, String channelId)

• markMessageRead

   final Call<Unit> markMessageRead(String channelType, String channelId, String messageId)

• showChannel

   final Call<Unit> showChannel(String channelType, String channelId)

• hideChannel

   final Call<Unit> hideChannel(String channelType, String channelId, Boolean clearHistory)

• truncateChannel

   final Call<Channel> truncateChannel(String channelType, String channelId)

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

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

• stopWatching

   final Call<Unit> stopWatching(String channelType, String channelId)

• updateChannel

   final Call<Channel> updateChannel(String channelType, String channelId, Message updateMessage, Map<String, Object> channelExtraData)

  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:

  channelType - the channel type.

  channelId - the channel id.

  updateMessage - the message object allowing you to show a system message in the channel

  channelExtraData - the updated channel extra data

• updateChannelPartial

   final Call<Channel> updateChannelPartial(String channelType, String channelId, Map<String, Object> set, List<String> unset)

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

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

  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

• enableSlowMode

   final Call<Channel> enableSlowMode(String channelType, String channelId, 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:

  channelType - the channel type.

  channelId - the channel id.

  cooldownTimeInSeconds - the duration of the time interval users have to wait between messages

• disableSlowMode

   final Call<Channel> disableSlowMode(String channelType, String channelId)

  Disables slow mode for the channel.

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

• rejectInvite

   final Call<Channel> rejectInvite(String channelType, String channelId)

• sendEvent

   final Call<ChatEvent> sendEvent(String eventType, String channelType, String channelId, Map<Object, Object> extraData)

  Sends an event to all users watching the channel.

  Parameters:

  eventType - the event name

  channelType - the channel type.

  channelId - the channel id.

  extraData - the event payload

• getVersion

   final String getVersion()

• acceptInvite

   final Call<Channel> acceptInvite(String channelType, String channelId, String message)

• markAllRead

   final Call<Unit> markAllRead()

• markRead

   final Call<Unit> markRead(String channelType, String channelId)

• updateUsers

   final Call<List<User>> updateUsers(List<User> users)

• updateUser

   final Call<User> updateUser(User user)

• partialUpdateUser

   final Call<User> partialUpdateUser(String id, Map<String, Object> set, List<String> unset)

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

  Parameters:

  id - user ids

  set - the key-value data which will be added to the existing user object

  unset - the list of fields which will be removed from the existing user object

• queryUsers

   final Call<List<User>> queryUsers(QueryUsersRequest query)

• addMembers

   final Call<Channel> addMembers(String channelType, String channelId, List<String> members)

• removeMembers

   final Call<Channel> removeMembers(String channelType, String channelId, List<String> members)

• muteChannel

   final Call<Unit> muteChannel(String channelType, String channelId, 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:

  channelType - the channel type.

  channelId - the channel id.

  expiration - the duration of mute in millis

• muteChannel

   final Call<Unit> muteChannel(String channelType, String channelId)

  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:

  channelType - the channel type.

  channelId - the channel id.

• unmuteChannel

   final Call<Unit> unmuteChannel(String channelType, String channelId)

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

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

• muteUser

   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

   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

   final Call<Unit> unmuteUser(String userId)

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

  Parameters:

  userId - the user id to unmute

• unmuteCurrentUser

   final Call<Unit> unmuteCurrentUser()

• muteCurrentUser

   final Call<Mute> muteCurrentUser()

• flagUser

   final Call<Flag> flagUser(String userId)

• unflagUser

   final Call<Flag> unflagUser(String userId)

• flagMessage

   final Call<Flag> flagMessage(String messageId)

• unflagMessage

   final Call<Flag> unflagMessage(String messageId)

• translate

   final Call<Message> translate(String messageId, String language)

• banUser

   final Call<Unit> banUser(String targetId, String channelType, String channelId, String reason, Integer timeout)

• unbanUser

   final Call<Unit> unbanUser(String targetId, String channelType, String channelId)

• shadowBanUser

   final Call<Unit> shadowBanUser(String targetId, String channelType, String channelId, String reason, Integer timeout)

• removeShadowBan

   final Call<Unit> removeShadowBan(String targetId, String channelType, String channelId)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore, Date createdAtBeforeOrEqual)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual, Date createdAtBefore)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter, Date createdAtAfterOrEqual)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset, Integer limit, Date createdAtAfter)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset, Integer limit)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort, Integer offset)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter, QuerySort<BannedUsersSort> sort)

• queryBannedUsers

   final Call<List<BannedUser>> queryBannedUsers(FilterObject filter)

• setPushNotificationReceivedListener

   final Unit setPushNotificationReceivedListener(PushNotificationReceivedListener pushNotificationReceivedListener)

• getConnectionId

   final String getConnectionId()

• getCurrentUser

   final User getCurrentUser()

• getCurrentToken

   final String getCurrentToken()

• isSocketConnected

   final Boolean isSocketConnected()

• channel

   final ChannelClient channel(String channelType, String channelId)

  Returns a ChannelClient for given type and id

  Parameters:

  channelType - the channel type.

  channelId - the channel id.

• channel

   final ChannelClient channel(String cid)

  Returns a ChannelClient for given cid

  Parameters:

  cid - the full channel id.

• createChannel

   final Call<Channel> createChannel(String channelType, String channelId, Map<String, Object> extraData)

• createChannel

   final Call<Channel> createChannel(String channelType, String channelId, List<String> members)

• createChannel

   final Call<Channel> createChannel(String channelType, List<String> members)

• createChannel

   final Call<Channel> createChannel(String channelType, List<String> members, Map<String, Object> extraData)

• createChannel

   final Call<Channel> createChannel(String channelType, String channelId, List<String> members, Map<String, Object> extraData)

• getSyncHistory

   final Call<List<ChatEvent>> getSyncHistory(List<String> channelsIds, Date lastSyncAt)

  Returns all events that happened for a list of channels since last sync (while the user was not connected to the web-socket).

  Parameters:

  channelsIds - the list of channel CIDs

  lastSyncAt - the last time the user was online and in sync

• devToken

   final String devToken(String userId)