Changelog: Twilio Chat Android SDK 4.x

aar docs javadocs

• Fixed a bug when channel attributes are empty when onChannelAdded called after re-joining to private channel.

aar docs javadocs

• Fixed a bug when channel attributes are empty when onChannelAdded called.
• Reduced SDK footprint.

aar docs javadocs

• Errors are now more human-readable for debugging purposes.
• Fixed a bug related to joinChannel callback. Sometimes was not called.
• Improved logging.

aar docs javadocs

• Fixed a native crash in makeUserDescriptor().
• Fixed a bug where isOnline() and isNotifiable() in TMUserDescriptor always returned false.
• Fixed processing failed result in consumption horizon.
• Fixed a bug where calling add or invite members double callbacks while offline.
• Fixed deadlock in getChannel().

aar docs javadocs

• Minimum Android SDK version decreased to 19.
• Fixed a bug where getAndSubscribeUser() method doesn't work anymore after calling User.unsubscribe().

aar docs javadocs

• Fixed a bug that caused an excessive subscription retry loop on failure, which would lead to an increased network and battery consumption.
• Fixed a bug where getMessageByIndex() sometimes resulted in Could not retrieve Message by index error when messages were not cached.
• Included a valid ProGuard configuration with the SDK archive (AAR).
• Improved documentation on getMessagesAfter/Before behavior.

aar docs javadocs

• Fixed a bug where an incorrect message index was received in ChatClientListener.onNewMessageNotification() after calling ChatClient.handleNotification().

aar docs javadocs

• Reduced SDK footprint, resulting in a noticeable decrease in final application size compared to release 4.2.0.

aar docs javadocs

• Fixed stack dump symbolication on Сrashlytics. In order to make the symbolication work, we needed to reconfigure linker which led to increase of SDK footprint by 10%. We are working hard on reducing the SDK size in next releases.
• Fixed retrieving member attributes when invoked immediately after client initialization.

aar docs javadocs

• Added the Member.getType() method to obtain information about the type of a member (chat/sms/whatsapp/other).
• Fixed a misleading error message when fetching a user descriptor for a user-less member, or subscribing to a user-less member.

aar docs javadocs

• Fixed a race condition when invoking ChannelListener.onTypingStarted() / .onTypingEnded().

aar docs javadocs

• Fixed a bug when removing a Member from Channel.

aar docs javadocs

• Added Message.getMemberSid() and Message.getMember() methods to obtain information about the author of a message.

aar docs javadocs

• Improved stability on shutdown, fixed crash issue.
• Fixed memory leaks in media upload.
• Fixed crash on media download in bad networking conditions.

aar docs javadocs

• Improved connection reliability under bad network conditions.
• Fixed unexpected connectivity errors with code 1401: Unable to establish connection to Twilio Sync service.
• Fixed behavior for UpdateAttributes in Message and User, now updating with null value calls listener's onError().
• Improved documentation for Channel Members.

• Increased targetSdkVersion to 28 in preparation for Google SDK policy targeted in August; minSdkVersion remains 21.

aar docs javadocs

• SDK size reduction - it gained over the course of the year, so we sent it to the gym. Native libraries are now repackaged and optimized for size.

aar docs javadocs

• Fixed crash on shutdown

aar docs

• Fixed crash on restoring after disconnected or backgrounded state
• Fixed memory leaks in media upload

aar docs

• Removed previously deprecated Message.getTimeStampAsDate(). Use Message.getDateCreatedAsDate() instead.

• Calling ChatClient.updateToken() may now indicate an error to the listener if the token validation failed.

• Introduced Push Notification Muting, with per-channel user notification preferences.

  • Added Channel.getNotificationLevel() and Channel.setNotificationLevel(NotificationLevel, StatusListener).
  • Added Channel.NotificationLevel enum with values .DEFAULT to receive notifications and .MUTED to suppress them. Upon leaving the channel, the mute setting for this User is reset to .DEFAULT.
  • Added Channel.UpdateReason.NOTIFICATION_LEVEL enum value when notification level changes.
  • NOTE: You need to grant editNotificationLevel permission to the user roles to be able to change this setting. See the Chat Permissions documentation.

• Added new token lifecycle management delegate callbacks which reduce the need for AccessManager integration when only using one Twilio client SDK:

  • ChatClientListener.onTokenAboutToExpire() is called when a token has 3 minutes or less left until expiry and should be refreshed.
  • ChatClientListener.onTokenExpired() is called when a token is already expired and must be refreshed to reconnect to the service.

• New logging level android.log.LogLevel.VERBOSE is now supported. Use this value to generate logs when reporting SDK issues to Twilio. As before, the default log setting is .SILENT, producing no SDK debug output at all.

• Added Member.UpdateReason.ATTRIBUTES enum value. There's currently no way to query member attributes, it will be added in the following SDK version.

• Added logging of android.os.Build.{BOARD,BRAND,DEVICE,DISPLAY,FINGERPRINT,HARDWARE,MANUFACTURER,MODEL,PRODUCT} on ChatClient startup - this data is logged into the local android log only and is helpful in diagnosing problems, please include it when submitting logs in bug reports!

• Added @NonNull annotations to methods in Messages class.

• Overhauled transport and communication layer, significantly improving network traffic overhead and client performance.

• Provided numerous fixes for improving client stability, focusing on runtime and shutdown crashes.

aar docs

• Resolve crash on shutting down on Oreo devices.
• Resolve crash on shutdown after calling getLastMessages().

aar docs

• Deprecated Message.getTimeStampAsDate(), use Message.getDateCreatedAsDate() instead.

• Added Channels.getSubscribedChannelsSortedBy() to obtain a list of subscribed channels sorted based on a few available criteria: Channel.SortCriterion.LAST_MESSAGE, Channel.SortCriterion.FRIENDLY_NAME, Channel.SortCriterion.UNIQUE_NAME.
• Added Channel.getLastMessageDate() and Channel.getLastMessageIndex() to obtain information about last message activity in the channel.
• Added Channel.UpdateReason.LAST_MESSAGE for last channel message change, you can inspect the two above-mentioned properties of the Channel after receiving this update for new values.

• Resolve crash on accessing last messages in the Channel after some patterns of message deletion.
• Fix local reference table overflow when clearing more than 512 objects from cache.

aar docs

• Made disposed object checks non-fatal - they only log an ERROR level message now.

• You must now request at least 1 message from the channel in Messages.getLastMessages() query. It used to be possible to query for 0 messages and receive no results, but not anymore.
• GDPR-compliance by default - uses log level SILENT to not output anything from SDK by default. Switch to higher debug level using ChatClient.setLogLevel() to receive log messages.

This version is a major version bump due to semver. There are a number of incompatible API changes making this bump necessary.

aar docs

These updates have changed the API in a backwards-incompatible manner.

• ChannelListener.onTypingStarted/onTypingEnded methods now include a Channel in which this event has happened in the signature.
• Chat messages that include media content previously returned a placeholder string "Media messages are not supported". This has caused some confusion, so these messages now return null body instead. Be careful to handle this case properly because it may cause NPEs in the your application if you don't.
• Message.getTimeStamp has been renamed Message.getDateCreated for clarity. The returned value has not changed.
• ChatClientListener.onNotification() method for receiving push notifications has been split into 4 separate methods:
  • onNewMessageNotification(String channelSid, String messageSid, long messageIndex)
  • onAddedToChannelNotification(String channelSid)
  • onInvitedToChannelNotification(String channelSid)
  • onRemovedFromChannelNotification(String channelSid) Now the parameters to these methods are more logical - for example there's no messageSid parameter when it is unused. The new messageIndex parameter provides an easier interface if you need to scroll to a message in the channel from push notification.
• Behavior of Channel.join and Members.add/addByIdentity has changed - methods will fail if user is already a member of the channel.
• Previously deprecated methods are now removed:
  • Messages.advanceLastConsumedMessageIndex(), use advanceLastConsumedMessageIndexWithResult() instead.
  • Messages.setLastConsumedMessageIndex(), use setLastConsumedMessageIndexWithResult() instead.
  • Messages.setAllMessagesConsumed(), use setAllMessagesConsumedWithResult() instead.
  • Messages.setNoMessagesConsumed(), use setNoMessagesConsumedWithResult() instead.

• Media queueing support has been added for media messages, to better utilize upload bandwidth.
• Online documentation format has changed to a more usable one (with search).

• CallbackListener for ChatClient.create will be called on the originating thread. Previously it was called from library thread by mistake.
• Android CA store certificates can be used for connections where possible. This means custom company certificates added on devices should now be honored by the SDK. To enable this feature use ChatClient.Properties.Builder's setDeferCertificateTrustToPlatform(boolean) with value true. By default Twilio-pinned certificate bundle will be used.
• ChatClientListener.onChannelAdded() will be called regardless of if the channel's status is known yet or not, it was not called before if channel status was not yet determined.
• Various internal bugfixes.

aar docs

• Fixed crash on shutdown due to local reference table overflow.
• Made disposed object checks non-fatal - they only log an ERROR level message now.

aar docs

• Fixed possible crash on shutdown.

aar docs

• Updated internal certificate store for upcoming certificate authority changes.

aar docs

• Forward current connection state to the newly added listener. It's impossible to lose client connection state change between client creation and listener assignment now.
• Implement better multithreading in channel listener callbacks. It's now more robust during concurrent modifications to the channel listeners list.

aar docs

• Optimized SDK speed.
• Optimized SDK size.
• Improved stability.

aar docs

• Added back the javadocs that went missing after 2.0.3-rc3

aar docs

• Fixed an issue where shutting down ChatClient on Android Oreo devices (8.0+) could crash.

aar docs

• Fixed an issue where a disposed ChatClient would attempt to reconnect to Twilio on application foregrounding.
• BEHAVIORAL CHANGE: Bug-fix so joining an already joined channel or attempting to add an already joined member to a channel will now correctly return a failure result.
• Fixed an issue where the ChatClient could sometimes crash during initialization.
• Unconsumed messages count on joined channels should immediately reflect changes made by new consumption horizon update methods described below.
• Improved documentation.

• Added logging to reflect ChatClient detecting the application transitioning into the background or foreground.
• Improvements to memory utilization.
• Unimplemented Channel.setType() removed from the SDK.
• Added updated consumption horizon methods which return an updated number of unconsumed messages in the listener callback:
  • setLastConsumedMessageIndexWithResult()
  • advanceLastConsumedMessageIndexWithResult()
  • setAllMessagesConsumedWithResult()
  • setNoMessagesConsumedWithResult()

• Deprecated old consumption horizon update methods which did not take a completion listener. Please use the newly added methods which do accept a completion listener above.
  • setLastConsumedMessageIndex()
  • advanceLastConsumedMessageIndex()
  • setAllMessagesConsumed()
  • setNoMessagesConsumed()

aar docs

• SDK will no longer crash on client construction on devices prior to API 21.
• Re-connection to the Chat service will occur faster when bringing the application to the foreground.
• Both chat client creation and updateToken() once again give feedback if the provided token is expired or otherwise invalid.
• Fixed an issue where the listener for joinChannel sometimes was not called.
• Fixed an issue where properties of Message were sometimes not fully populated by the time sendMessage's listener was called.

aar docs

• Added Multimedia Messaging (beta) API (see Media Support for more information). Note: Sending media messages on existing instances requires adding a new permission in your channel roles.
  • Added Message.Media, Message.getType().

• BREAKING: Added UpdateReasons to onMessageUpdated and onMemberUpdated callbacks.
• BREAKING: Removed the deprecated enum SynchronizationStrategy.
• BREAKING: Use Message.Options to construct and sendMessage()
  • You now could fully initialize necessary message attributes before sending it out.
• BREAKING: Members.add(), .addByIdentity(), .invite(), .inviteByIdentity(), .removeByIdentity() updated to new chat-lib API
• Return empty JSON object instead of empty string if Message attributes are empty.

• Fixed a crash on API 19 devices that prevented SDK use.

aar docs

• Updated internal certificate store for upcoming certificate authority changes.

aar docs

• Optimized SDK speed.
• Optimized SDK size.
• Improved stability.

aar docs

• Fixed an issue where shutting down ChatClient on Android Oreo devices (8.0+) could crash.
• Fixed an issue where already disposed ChatClient would attempt to reconnect on application foregrounding.
• Fixed a potential issue where ChatClient could not release some resources on shutdown.
• Add logging of application backgrounding and foregrounding events to improve debugging.

aar docs

• Fixed an infrequently occurring crash on chat client shutdown.
• SDK will no longer crash on client construction on devices prior to API 21.
• Re-connection to the Chat service will occur faster when bringing the application to the foreground.
• Both chat client creation and updateToken() once again give feedback if the provided token is expired or otherwise invalid.
• Fixed an issue where the listener for joinChannel sometimes was not called.
• Fixed an issue where properties of Message were sometimes not fully populated by the time sendMessage's listener was called.

aar docs

• Performance enhancements for client startup and data retrieval.

aar docs

• channel.join() listener will be called after joined channel has been completely synchronized.

aar docs

• Fixed issues related to thread management, which in many cases should lead to significant performance gains
• Fixed crashes on Client shutdown.

aar docs

• Fixed an issue whereby setAllMessagesConsumed() in an empty channel could cause the SDK client to crash.

aar docs

• Fixed an issue whereby GCM/FCM unregistration callbacks were not reliably being called.

aar docs

• Fixed additional issues with some commands not correctly completing - i.e. no success callback nor failure was received. This release fixes cases not addressed by the previous release.
• Updated documentation to address inconsistencies.
• Fixed a crash when passing null Properties to ChatClient.create(). An IllegalStateException will now be thrown instead.
• Updated log messages to not mention non-existing Channel.synchronize() anymore.
• Addressed status callback threading issues related to Member.getUserDescriptor()/.getAndSubscribeUser().
• Ensure that Channel listener's synchronisation status callback immediately upon add in all cases.
• Added creation of notification payload from FCM RemoteMessage contents.
• Added a new helper method: Channel.SynchronizationStatus.isAtLeast().

aar docs

• Fixed a bug whereby some commands did not correctly complete - i.e. no success callback nor failure was received. This release fixes cases not addressed by the previous release.
• Fixed a bug whereby SDK would crash in some circumstances while creating a Chat Client instance.

aar docs

• Fixed a bug whereby client initialization did not completed correctly - i.e. no success nor failure callback was received for client creation
• Fixed a bug whereby some commands did not correctly complete - i.e. no success callback nor failure was received

aar docs

• Fixed a bug whereby after a call to client.shutdown() sometimes caused New Message push registrations to be lost for the endpoint.

aar docs

Changes are grouped by class to ease migration.

• changed default log level from Log.DEBUG to Log.WARN
• previously deprecated initialMessageCount setting has been removed
• removed functions:
  • int getInitialMessageCount()
  • Builder ChatClient.Builder.setInitialMessageCount(int initialMessageCount)
• UserInfo has been replaced with User/UserDescriptor and direct getting of UserInfo has been replaced with identity getters.
  • replaced UserInfo getMyUserInfo() with String getMyIdentity()
• added new function to access user information Users getUsers()

• added new functions:
  • void onUserSubscribed(User user)
  • void onUserUnsubscribed(User user)
• changed functions:
  • renamed onChannelAdd to onChannelAdded
  • renamed onChannelJoin to onChannelJoined
  • renamed onChannelInvite to onChannelInvited
  • renamed onChannelDelete to onChannelDeleted
  • renamed onToastNotification to onNotification
  • renamed onToastSubscribed to onNotificationSubscribed
  • renamed onToastFailed to onNotificationFailed
  • replaced void onChannelChange(Channel) with void onChannelUpdated(Channel, Channel.UpdateReason reason)
  • replaced void onUserInfoChange(UserInfo userInfo, UserInfo.UpdateReason reason) with void onUserUpdated(User user, User.UpdateReason reason)

• added new value for Channel.ChannelStatus enum:
  • UNKNOWN - channels returned in ChannelDescriptor do not have status information
• added new Channel.UpdateReason enum to indicate reason for channel update, with values:
  • STATUS
  • LAST_CONSUMED_MESSAGE_INDEX
  • UNIQUE_NAME
  • FRIENDLY_NAME
  • ATTRIBUTES
• removed function (you no longer need to explicitly synchronize channels):
  • void synchronize(CallbackListener<Channel>)

• added new functions:
  • long getUnconsumedMessagesCount()
  • Channel.ChannelStatus getStatus()

• renamed getPublicChannels to getPublicChannelsList
• added new functions:
  • void getUserChannelsList(CallbackListener<Paginator<ChannelDescriptor>>)
  • List<Channel> getSubscribedChannels()
  • List<Member> getMembersByIdentity(String identity)

• changed functions:
  • renamed onMessageAdd to onMessageAdded
  • renamed onMessageChange to onMessageUpdated
  • renamed onMessageDelete to onMessageDeleted
  • renamed onMemberJoin to onMemberJoined
  • renamed onMemberAdd to onMemberAdded
  • renamed onMemberChange to onMemberUpdated
  • renamed onMemberDelete to onMemberDeleted
  • renamed onSynchronizationChange to onSynchronizationChanged

• added new functions:
  • int getStatus()
  • String toString()
• changed functions:
  • renamed getErrorCode to getCode
  • renamed getErrorText to getMessage

• added new functions:
  • void getUserDescriptor(CallbackListener<UserDescriptor> listener)
  • void getAndSubscribeUser(CallbackListener<User> listener)
• changed function:
  • replaced UserInfo getUserInfo() with String getIdentity()

• added new functions:
  • Channel getChannel()
  • Member getMember(String identity)
  • void add(Member member, StatusListener listener)
  • void invite(Member member, StatusListener listener)
  • void removeByIdentity(String identity, StatusListener listener)
• changed functions:
  • replaced void getMembers(CallbackListener<Paginator<Member>> listener) with List<Member> getMembersList()
  • renamed removeMember to remove

• renamed UserInfo to User class
• added new functions:
  • void unsubscribe()
  • boolean isSubscribed()

• added new class UserDescriptor with functions:
  • String getFriendlyName()
  • JSONObject getAttributes()
  • String getIdentity()
  • boolean isOnline()
  • boolean isNotifiable()
  • subscribe(CallbackListener<User> listener)

• added new class Users with functions:
  • void getChannelUserDescriptors(String channelSid, CallbackListener<Paginator<UserDescriptor>> listener)
  • void getUserDescriptor(String identity, CallbackListener<UserDescriptor> listener)
  • void getAndSubscribeUser(String identity, CallbackListener<User> listener)
  • List<User> getSubscribedUsers()
  • User getMyUser()

• Getting non-existing message by index now properly fails.

aar docs

• Fixed an issue whereby Push Credential registrations were firing onSuccess on each state change
• Fixed a race condition whereby on channel creation, onChannelAdded and onChannelJoined events failed to fire correctly

aar docs

• Added FCM support via ChatClient.registerFCMToken(), ChatClient.unregisterFCMToken()
• Return a proper error if the internal token and a manual token update causes a mismatch
• Expose additional error codes to client. ErrorInfo.CANNOT_GET_MESSAGE_BY_INDEX and ErrorInfo.MISMATCHING_TOKEN_UPDATE

• Fixed an issue where a certain character caused a crash \v
• Added missing Message.getTimeStampAsDate()

aar docs

• The endpoint_id identifier specified in access tokens is now automatically generated and persisted in the local app storage. The following should be observed with this change:
  • endpoint_id is no longer a required identifier in your generated access tokens, you may omit it from this build forward
  • endpoint_id will be ignored if specified with your access token
• Fully asynchronous client init - Client listener onError() will be called if any service error happens during client creation. - Client will not be created in this case.
• Initial message count is completely ignored by init code, 0 is always used - messages are loaded when a channel is loaded.
• Security enhancements

• Added missing Channel.getCreatedBy() and ChannelDescriptor.getCreatedBy() to return creator's identity
• Fixed a bug whereby a constant CPU load was generated by the SDK client when initialized.

aar docs

• Added a call to the onClientSynchronization callback in the registered listener upon ChatClient.setListener(), passing the current client synchronization state

aar docs

• Fixed an issue where the getPublicChannels() caused a crash

aar docs

• Rename IP Messaging to Programmable Chat
• IPMessagingClient is renamed to ChatClient
• com.twilio.ipmessaging is renamed to com.twilio.chat
• AccessManager is removed from SDK

• Channel.removeAllListeners() removes all added listeners.
• Channel.getMessagesCount()
• Channel.getUnconsumedMessagesCount()
• Channel.getMembersCount()
• Channels.getPublicChannels() returns ChannelDescriptors, and this list is not updated in realtime.
• onUserInfoUpdated added UpdateReason.

• BREAKING Do not return IPMessagingClient before it was fully initialized. IPMessagingClient.create() no longer returns a value, you can obtain reference to created IPMessagingClient only in listener's onSuccess() callback.
• BREAKING Channel.setListener() replaced with addListener() to support assigning multiple listeners
• BREAKING Channel.removeListener() now accepts listener ptr to remove only that one
• BREAKING Replace custom CreateChannelListener in Channels.createChannel() with generic CallbackListener<Channel>. Listener's onCreated(Channel) is therefore renamed onSuccess(Channel).
• BREAKING IPMessagingClient.handleNotification() now accepts NotificationPayload instead of Map<String,String>
• BREAKING Messages.getMessageByIndex() has been changed to asynchronous interface.
• BREAKING Members.getMembers() has been changed to asynchronous interface.
• BREAKING Channel invite logic changes.
• BREAKING Constants interface is removed, StatusListener and CallbackListener<T> are standalone classes now.

• BREAKING Removed built-in AccessManager, IPMessagingClient.create() now accepts only String token. IPMessagingClient.updateToken() is provided to update it.
  • Use com.twilio:accessmanager-android:0.1.0 from jcenter
  • Removed twilio-common from dependencies.
• BREAKING Remove previously obsoleted ChannelListener.onAttributesChange()
• BREAKING Remove previously deprecated Channels.createChannel() with attributes map.
• BREAKING Remove previously deprecated TwilioIPMessagingSDK
• BREAKING Remove previously deprecated InitListener
• BREAKING Remove previously deprecated Messages.getMessages()