Method Detail

• getNotificationHandler

   final ChatNotificationHandler getNotificationHandler()

• getDisconnectListeners

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

• getPreSetUserListeners

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

• getConfig

   final ChatClientConfig getConfig()

• setUser

   final Unit setUser(User user, String token, InitConnectionListener listener)

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

• setUser

   final Unit setUser(User user, TokenProvider tokenProvider, InitConnectionListener listener)

  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

  listener - socket connection listener

• 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

• setUserWithoutConnecting

   final Unit setUserWithoutConnecting(User user, String userToken)

  Initializes ChatClient for a specific user and a given userToken. 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.

  Parameters:

  user - the user to set

  userToken - the user token

• setAnonymousUser

   final Unit setAnonymousUser(InitConnectionListener listener)

• connectAnonymousUser

   final Call<ConnectionData> connectAnonymousUser()

• setGuestUser

   final Unit setGuestUser(String userId, String username, InitConnectionListener listener)

• connectGuestUser

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

• getGuestToken

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

• sendFile

   final Call<String> sendFile(String channelType, String channelId, File file, ProgressCallback callback)

• sendImage

   final Call<String> sendImage(String channelType, String channelId, File file, ProgressCallback callback)

• queryMembers

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

• deleteFile

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

• deleteImage

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

• 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(Function1<ChatEvent, Unit> listener)

• subscribe

   final Disposable subscribe(ChatEventListener<ChatEvent> listener)

• subscribeFor

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

  Subscribes to the specific eventTypes of the client.

• 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, Function1<ChatEvent, Unit> 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(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, Function1<ChatEvent, Unit> listener)

  Subscribes to the specific eventTypes of the client.

• 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, Function1<ChatEvent, Unit> 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(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, Function1<ChatEvent, Unit> listener)

  Subscribes for the next event with the given eventType.

• 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, Function1<T, Unit> 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(String deviceId)

• addDevice

   final Call<Unit> addDevice(String deviceId)

• 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

• 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)

• pinMessage

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

• pinMessage

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

• unpinMessage

   final Call<Message> unpinMessage(Message message)

• 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)

• stopWatching

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

• updateChannel

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

• 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)

• disableSlowMode

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

• rejectInvite

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

• sendEvent

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

• 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)

• 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)

• muteUser

   final Call<Mute> muteUser(String userId)

• muteChannel

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

• unMuteChannel

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

• unmuteChannel

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

• unmuteUser

   final Call<Unit> unmuteUser(String userId)

• 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)

• 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)

• onMessageReceived

   final Unit onMessageReceived(RemoteMessage remoteMessage)

• onNewTokenReceived

   final Unit onNewTokenReceived(String token)

• 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)

• devToken

   final String devToken(String userId)