Changelog: Twilio Chat Android SDK

We recommend referencing this release per the below. As we release backwards-compatible patches, these references will automatically include fixes in your project.

• Gradle dependencies { implementation 'com.twilio:chat-android:7.0.1' }
• Maven
  See the chat-android Maven Central page for download links.
• SDK Documentation

If you need help installing these frameworks in your project, see our installation guidance.

Twilio Programmable Chat SDKs use Semantic Versioning. Twilio supports version N-1 for 12 months after the first GA release of version N. We recommend that you upgrade to the latest version as soon as possible to avoid any breaking changes. Version 7.x is the latest Android version.

Support for 6.x will cease on May 17, 2022. Please upgrade to the latest version

Support for 5.x ceased on July 20, 2021.

Support for 4.x ceased on March 5, 2021.

End-of-Life for 3.x occurred on December 10, 2020.

End-of-Life for 2.x occurred on April 10, 2020.

End-of-Life for 1.x occurred on June 30, 2019.

Links are provided to specific patch versions here. We don't recommend using these links unless you have a specific need for a certain patch.

• aar sha256:da0c837ddbb47fd9971f801b8c3536696f1cb74d48d6b8d6bb4c9cc234d22f7e
• Documentation

• Fixed a bug when onChannelAdded event sometimes didn't arrive after restoring application from background

• aar sha256:04457c2f02b13c9fe407841c86cc408144afcfcbf8f3133c9b63de96a4d91d24
• Documentation

• Major under-the-hood improvement (the "Sessionless" protocol).
  This improvement is designed primarily for improved reliability. While this is not a breaking code change, it does carry a meaningful impact on timing:

  • SDK commands will return success or failure up to ~10% more quickly than before.
  • Real-time updates of data are now likely to arrive after the command completes.
    For example, Channel.setAttributes() will invoke completion (i.e., success) while Channel.getAttributes() still returns the old value. To see the new value, we recommend waiting for an update event via ChatClientListener#onChannelUpdated.

• aar sha256:e403ee284d774285bfffc3ec5325872dcfbe3b2f26cba0fe69dbc004b908f575
• Documentation

• Fixed a reconnection issue after restoring application from background.

• aar sha256:f8d388cb4d3417efb5be67e589d2b85bbf9838f5d7ae2d3f074a6699a704a6a4
• Documentation

• Reduced SDK footprint
• Fixed a bug when user update event with reason ReachabilityOnline is not received in some cases

Starting from this release all artifacts are published on mavenCentral instead of jcenter. Root build.gradle have to be updated by adding mavenCentral() repository:

1
allprojects {
2
    repositories {
3
        mavenCentral()
4
    }
5
}

• aar sha256:c71270b35e1f17cb352e55958f7a2fc451cd31c6689b3906fc012cbf4f262916
• Documentation
• javadocs

• Added connection via proxy support. See ChatClient.Properties.Builder.setUseProxy().
• Fixed a bug when onChanelDeleted doesn't come for a private channel when a member is removed by another user.
• Fixed a bug that could lead to client synchronization getting stuck.

• Update to v6.2.1 or newer, if you got runtime error: java.lang.NoClassDefFoundError: Failed resolution of: Lcom/getkeepsafe/relinker/ReLinker.

aar Documentation javadocs

• Fixed a bug that could lead to crashes when member attributes are updated.

aar Documentation javadocs

• SDK has switched to Android's native SSLSocket implementation (javax.net.ssl.SSLSocket), resulting in a noticeable decrease in final application size compared to release 6.0.0.

aar Documentation javadocs

• ChatClient can now have multiple observers.
  • Renamed setListener to addListener.
  • Changed removeListener() to removeListener(listener).
  • Added removeAllListeners().
• Now Channel.getUnconsumedMessagesCount() returns null instead of 0 if the message consumption horizon was not set.
  • Messages.setNoMessagesConsumedWithResult() always returns null instead of 0 (because it resets the consumption horizon).
• Media message body is not hardcoded to always return null anymore. Returns actual value received from the backend instead.
• Added Member.UpdateReason.LAST_CONSUMPTION_TIMESTAMP.
  • This as a result also changed the value of Member.UpdateReason.ATTRIBUTES (potentially silently breaking change if this value was serialized).

• Added NotificationPayload.getMessageIndex() and NotificationPayload.INVALID_MESSAGE_INDEX for retrieving the message index from push notifications.
• Exposed Message.dateUpdated, dateUpdatedAsDate and lastUpdatedBy.
  • lastUpdatedBy will be null if messages were not edited, or it will contain the identity of the last user who edited this message.
• Added Message.Media.getContentTemporaryUrl() to get a temporary direct link to Media content.
  • Message.Media.download(OutputStream) is deprecated.
  • To download Media by direct URL, use some external mechanism, such as Android Download Manager or java.net.URL.readText().

aar Documentation javadocs

• Fixed the bug when connection is dropped with message The WebSocket message exceeded the locally configured limit.

This version has been deprecated — please use 5.1.1.

aar Documentation javadocs

• Added ability to specify custom command timeout for operations like send message, join to a channel, etc.

This version has been deprecated June 1, please use 5.1.1.

aar Documentation javadocs

• Improved stability, fixed crashes.

aar Documentation javadocs

• Introduced a type-safe interface Attributes for Channel, Message, Member and User. Attributes type allows attributes to be represented as JSON types JSONObject, JSONArray, String, Number or NULL. You could query attributes to understand what type you've received.
• registerGCMToken()/unregisterGCMToken() now uses GCMToken as a parameter type instead of String.
• registerFCMToken()/unregisterFCMToken() now uses FCMToken as a parameter type instead of String.

Here are examples of how code should be changed:

For attributes:

1
JSONObject json = channel.getAttributes();
2
json.put("newKey", "newValue");
3
channel.setAttributes(json);

replace with:

1
JSONObject json = channel.getAttributes().getJSONObject();
2
json.put("newKey", "newValue");
3
channel.setAttributes(new Attributes(json));

For GCM tokens:

1
String token = getToken();
2
chatClient.registerGCMToken(token);
3
chatClient.unregisterGCMToken(token);

replace with:

1
String token = getToken();
2
GCMToken gcmToken = new GCMToken(token);
3

4
chatClient.registerGCMToken(gcmToken);
5
chatClient.unregisterGCMToken(gcmToken);

For FCM tokens:

1
String token = getToken();
2
chatClient.registerFCMToken(token);
3
chatClient.unregisterFCMToken(token);

replace with:

1
String token = getToken();
2
FCMToken fcmToken = new FCMToken(token);
3

4
chatClient.registerFCMToken(fcmToken);
5
chatClient.unregisterFCMToken(fcmToken);

• Fixed incorrect behavior when user identity contained a back-tick character (`).
• Fixed unregistering from notifications while offline.

For older changelog entries, including 4.x, please see this changelog.