Android Offline

The offline library exposes easy to use LiveData/StateFlow objects for messages, reads, typing, members, watchers and more. It also adds support for offline chat. This means you can send messages, reactions and even create channels while you're offline. When the user comes back online, the library will automatically recover lost events and retry sending messages. The offline storage also enables it to implement optimistic UI updates.

Open up your app's module level build.gradle file and add the following line:

For the latest version, check our GitHub releases page.

The offline library builds on top of the client library. You can build your ChatDomain object like this:

You should only have a single ChatDomain object in your application. Note that the ChatDomain is user specific so you'll want to disconnect your ChatDomain and create a new one when the user in your app changes. You can retrieve the current chatDomain from anywhere in your app:

To disconnect from ChatDomain, just disconnect from ChatClient and it will trigger a disconnection for ChatDomain too:

By default, the retry policy for the ChatDomain is set to retry three times and wait attempt * 1000 milliseconds in between attempts. It will also retry when the connection recovers. You can customize the default behavior like this:

The chatDomain exposes the following LiveData objects for the user:

All operations on the ChatDomain are exposed via use case functions returning a Call instance. The following example shows how to get the messages, reads and typing information for a channel:

All use case functions return a Call object. You can run a Call in one of three ways:

• execute synchronously in the current thread (make sure this is not the UI thread!),

• enqueue asynchronously with a callback, which executes the call in the background and then notifies you on the UI thread,

• await it inside a coroutine, which is a suspending operation.

All calls return a Result object, which is either successful or an error, which you should always check this using isSuccess or isError, and then access either data() or error(). This behavior is identical to the low level client.

As you see in the example above, the channel controller exposes the messages, reads and typing LiveData objects. The full list of LiveData objects available is:

You can load more messages for a channel like this:

This is how you can send a message

The following use case functions help you update chat data

• createChannel()

• sendMessage()

• editMessage()

• deleteMessage()

• sendReaction()

• deleteReaction()

• keystroke() (sends a typing event as needed)

• stopTyping() (sends a stop typing event, only if needed)

• markRead() (marks the channel as read)

The other most commonly used interface for chat is showing a list of channels. You can query channels like this:

Loading more channels for a particular query can be done like this:

The following LiveData objects are available on a query channels controller

Stream provides 2 unread counts for a user. Here's how to retrieve LiveData objects for them:

Here's how you can retrieve the messages for a thread:

Loading more messages for a thread can be done like this: