Android (Modularized) v3.0.0

Release Date: October 2024

We are happy to announce that we are launching a new set of modular SDKs for Android to provide you with the flexibility to add selective functionality to your mobile apps depending on your requirements. Following are the module names:

  • webexconnect-core
  • webexconnect-push
  • webexconnect-fcm
  • webexconnect-hms
  • webexconnect-inappmessaging

Enhancements

  • Proactive unregistration for inactive app users.
  • SDK will now be disabled if support for the SDK version is discontinued.

❗️

Important

This version of the SDK requires devices to be re-registered with the Webex Connect platform. When upgrading from a previous version of the SDK, ensure that you execute your registration code again. Use the WebexConnect.instance.isRegistered method to determine the current registration status and conditionally execute your registration code.

Version 2.20.4

Enhancements

  • Fixed Geofence Permissions Handling issue.

Version 2.20.3

Release Date: July 2024

New Features

  • Android 15 compatibility changes.

Enhancements

  • Various internal improvements and enhancements.

Version 2.20.2

Release Date: February 2024

New Features

  • Added support for the Singapore environment

Enhancements

  • Resolved a connection issue that could occur when toggling between multiple profiles
  • Various internal improvements and enhancements

Version 2.20.1

New Features

  • Fixed an issue that was hindering policy updates upon application restart.

Enhancements

  • Various internal improvements and enhancements

Version 2.20.0

New Features

  • Introduced the fetchThread method to fetch the thread data for a given thread Id
  • Android 14 compatibility changes

Enhancements

  • Added support for sending acknowledgment for Thread Update Event
  • Various internal improvements and enhancements

Version 2.19.0

New Features

  • Decoupled the push permissions request from registration

Enhancements

  • Various internal improvements and enhancements

Version 2.18.0

New Features

  • Support multi select drop down as a new field type in form messages
  • Support for firebase messaging v23.0.8, play-services-base v18.1.0 version and location v20.0.0
  • Support for HMS version v6.5.0.300

Enhancements

  • Removed duplicate values from input array for set message status method
  • Various internal improvements and enhancements

Version 2.17.2

Enhancements

• Introduced handling for deduplication of Register/UnRegister API calls sent to platform
• Various internal improvements and enhancements

Version 2.17.1

New Features

• Introduced separate Android libraries for Google Mobile Services (GMS) and Huawei Mobile Services (HMS)
• Android 13 support for Notification runtime permission
• Introduced the ICMessaging.requestNotificationPermission method to request the system notification permission prompt to enable notifications display on Android 13 devices

Enhancements

• Fixed an issue that could cache API’s response
• Various internal improvements and enhancements.

Version 2.16.0

New Features

  • Introduced the Quick Reply message type to provide support for quick replies within in-app messaging.
  • Introduced the Generic Template message type to provide support for generic templates within in-app messaging.
  • Support for publishing postback event and click receipts to platform.

Enhancements

  • Various internal improvements and enhancements.

Version 2.15.5

Enhancements and Improvements

  • Fixed a crash that could occur when GMS / HMS dependencies are not present within an app binary
  • Added changes to handle error scenario where 3rd party SQLCipher library not loaded on specific architecture devices

Version 2.15.4

New Features

  • Support for firebase messaging 23.0.0 version
  • Support for HMS version to 6.1.0.300
  • Support for push notifications on Huawei devices below EMUI version 10
  • Introduced handling for deduplication of Read receipts sent to platform

What has changed

  • Various internal improvements and enhancements

Important :

2.15.4 will require min supported OS version to be Android OS 4.4 (API 19) and higher

Version 2.15.3

New Features

  • Introduced the ICMediaFileManager.regenerateMediaURL method to regenerate the media URL when secure URL is expired.

What has changed

  • ICMediaFileManager.UploadFile method enhanced to provide access token and JWT token as part of media upload API for secure authentication.
  • Internal improvements and enhancements

Version 2.15.2

New Features

  • It is now possible to include GMS / HMS dependencies as required. Previously, both dependencies were required irrespective of target device build (Google / Huawei)

What has changed

  • Fixed several crashes that could occur within the In-App Messaging transport layer under certain edge case conditions.
  • Fixed an issue that could prevent retry of failed Push Id profile updates.
  • Various internal improvements and enhancements

Version 2.15.1

New Features

  • Android 12 compatible changes
  • Support for firebase messaging 22.0.0 version
  • Support for HMS version to 5.x.x

What has changed

  • Various internal improvements and enhancements

Version 2.15.0

New Features

  • Introduced the option to allow SDK configuration via a new autogenerated properties file that can be downloaded from the Webex Connect app asset configuration page and embedded in the mobile app build.
  • Introduced support for push notifications on Huawei devices that only have access to Huawei Mobile Services.
  • Introduced the ‘Form’ message type to provide support for forms within in-app messaging.
  • Introduced a new parameter to pass the reason for closing a chat when calling the close thread method.
  • Introduced the ICMessaging.fetchUnreadThreadCount method to fetch the current count of unread messages for a given thread id.

What has changed

  • Various internal improvements and enhancements

Version 2.14.3

Release Date: April 2021
New Features

  • Added error handling to recover from a rare instance where an existing encrypted internal database cannot be opened, including adding a new config property to allow fallback to an unencrypted database if recovery fails.

Enhancements and Improvements

  • Upgraded SQLCipher library version to 4.4.3.

Limitations

If the config property to allow fallback to the unencrypted database is not enabled and opening an encrypted database fails then resilience systems that reattempt sending of previously failed delivery/read receipt or event data will not function. Duplicate in-app messages may be received through the message listeners/receiver, but any duplicates would not be present within API calls that fetch messages.

Version 2.14.2

Release Date: January 2021
New Features

  • Android 11 compatible changes
  • Supporting Async startup methods.

Enhancements and Improvements

  • Internal improvements and enhancements.

Version 2.14.1

New Features

  • Added support to allow delayed start of the SDK
  • Added support to allow auto-start of certain SDK components.

Enhancements and Improvements

  • Internal improvements and enhancements.

Version 2.14.0

New Features

  • Provided interface to get device push token and listener to receive push token updates
  • Migrating from Firebase Job Dispatcher to Work Manager.

Enhancements and Improvements

  • Internal improvements and enhancements.

Version 2.13.0

Release Date: May 2020
New Features

  • Co-existence with other push SDKs

Enhancements and Improvements

  • Upgraded SQLCipher library.

Version 2.12.0

Release Date: December 2019

New Features

  • Multi Profile support
  • Multiple users can log in to the same device. However, only one user remains active at any given point of time.
  • Fetch thread based on category or type.

Enhancements and Improvements

  • Revised device monitoring attributes

📘

With this version of SDK, only a few device attributes (15) are captured as opposed to all the attributes (52) earlier.

  • Internal improvements and enhancements.

Version 2.11.2

Release Date: 21-OCT-2019

Enhancements and Fixes

  • Android 10 Compatibility Changes
  • Replaced deprecated methods in push token generation
  • Migrating to AndroidX
  • Internal improvements and enhancements.

📘

Migration to AndroidX

You must migrate your apps to AndroidX to use any SDKs version 2.11.2 onwards.

Version 2.11.0

Release Date: 8-JUL-2019

New Features

  • Guest login option
  • In-App custom events
  • Delete message
  • Domain configuration to override zero-rating domain
  • In-App notifications

Enhancements and Fixes

  • Internal improvements and enhancements

Version 2.10.1

Release Date: 31-JAN-2019
Enhancements and Fixes

  • Internal improvements and enhancements
  • Upgraded SQLcipher library

Version 2.10.0

Release Date: 6-DEC-2018

Enhancements and Fixes

  • Android Pie compatibility improvements
  • Fixed several crashes within In-App Messaging related to edge cases.
  • Various internal enhancements and bug fixes.

Version 2.9.1

Release Date: 2-NOV-2018

Enhancements and Fixes

  • Fixed several crashes that could occur within the In-App Messaging transport layer under certain edge case conditions.

Version 2.9.0

Release Date: 18-AUG-2018

New Features

  • Introduced access token-based security for Webex Connect platform APIs that are accessed by the SDK.
  • Introduced AES encryption for all sensitive data in transit between the SDK and Webex Connect platform services.
  • Introduced client-specific sub-domains for Webex Connect platform access.
  • Various internal enhancements and bug fixes.

❗️

IMPORTANT

  • This version of the SDK requires that devices are re-registered with the Webex Connect platform in order for access tokens to be issued.

    • If upgrading from a previous version of SDK, please ensure that you execute your registration code again. The imiconnect.isRegistered method should be queried to determine the current registration status and conditionally execute your registration code.

      • AES encryption is only available for newly created Webex Connect platform apps. If support is required for existing apps, please contact your Webex Connect representative to discuss.

Version: 2.7.1

Release Date: 16-JUN-2018

Enhancements and Fixes

  • Corrected handling of duplicate geofence configuration
  • Fixed an issue that could produce invalid encryption keys
  • Other minor improvements and bug fixes

Version 2.7.0

Release Date: 29-MAY-2018

Enhancements and Fixes

  • For GDPR compliance:

  • Enhanced protection of encryption keys via Android Key Store

  • Deprecated ICDefaultMessageStore constructor that allows unencrypted message storage

  • Full encryption of internal database and preference files

  • In-App messaging enhancements

  • Removed usage of streams

  • Introduced enhanced thread capabilities:
    • Added update and close thread APIs.
    • Added custom attributes.
    • Added thread statuses.

New Features

  • Introduced user based geofences.

Version 2.5.0

Release Date: 26-JAN-2018

Enhancements and Fixes

  • Internal improvements and bug fixes.
  • Geofence enhancements to circumvent device limits.
  • Fixes for Geofencing permission requests.
  • Added temporary transaction id generation for newly created messages to support message storage before publication.
  • Mimetypes are now sent along with attachments during upload.
  • Exposed error message when an exception occurs during attachment upload.
  • Handled an exception that could stop In-App Messaging from functioning.
  • Changed ICMessaging.setMessageStore and getMessageStore to static.

Version 2.4.1

Release Date: 8-DEC-2017

Enhancements and Fixes

  • Android Oreo Compatibility changes.
  • Internal improvements and bug fixes.

Version 2.4.0

Release Date: 8-DEC-2017

New Features

  • Message Store - Introduces messaging persistence layer for RTM.
  • Messaging Synchronisation - Introduced message synchronization support.
  • ICMessagingListener introduced - Listener instances can now be registered directly with.
  • ICMessaging to allow direct notification of messages and connection change events.
  • ICMessageHelper introduced to allow sending of special typing indicator messages.

**Enhancements and Fixes**

  • Enhancements to message history APIs to better support synchronisation

Version 2.3.0

Release Date: 8-DEC-2017

New Features

  • Security Token System
  • InApp GeoFences

Enhancements and Fixes

  • Internal improvements and bug fixes

Version 2.2.1

Release Date: 8-DEC-2017

New Features

  • Create thread when encryption is enabled on Android SDK

Enhancements and Fixes

  • Thread creation for encryption is enabled

Impact Areas

  • Create Thread with encryption On/Off
  • Push/RT Notifications and messages

Version 2.0.0

Release Date: 8-DEC-2017

New Features

  • Implement device profile migration process
  • Logging Improvements
  • RTM Changes
  • Topic-based messaging
  • Introduce Attachment Upload Service
  • MQTT QoS 1 Support
  • FCM Support

Enhancements and Fixes

  • Device profile migration process updated
  • Improved Logging process.
  • RTM changes enhancement with Threads. MO or MT messages will be processed via Threads
  • Device sync for RT Messages.
  • Topic-based RT messages and Push notifications handled.
  • MQTT QOS 1 support added for Mosca.
  • SDK implemented support for FCM.

Impact Areas

  • Registration flow
  • Push/RT Notifications
  • DR/RR Reports

Version 2.0

Release Date: 17-APR-2017

New Features

  • App profile should be created with App user-id irrespective of master profile and application should get the app profiles based on the app user id. Changes Added for Android Core SDK

Enhancements and Fixes

  • APP profile creation flow.
  • Updated changes for Register API based on DeviceProfile,
  • Added setUser, Remove user, Remove App profile, set customerId, Remove customerId APIs in Core SDK

Impact Areas

  • Registration flow, Push/RT Notifications , RT Connect/disconnect events, Set User, Remove user,
  • Remove App profile, set customerId , Remove customerId, DR, RR reports.