Migration to version 8.1.x

Migration from 8.0.x to 8.1.0

Changes for the In-app chat

Version 8.1.0 onwards introduces the following changes to error handling and styling:

Removed

The following customization property has been removed:

Removed Property	Migration
networkErrorIconVisible	Icon is now always shown if provided. Remove this property from your MobileMessaging.setChatCustomization() call.

Before:

MobileMessaging.setChatCustomization({
  networkErrorIcon: 'path/to/icon.png',
  networkErrorIconVisible: true,  // This property is no longer supported
  // ... other properties
});

After:

MobileMessaging.setChatCustomization({
  networkErrorIcon: 'path/to/icon.png',  // Icon will be shown automatically if provided
  // ... other properties
});

New

New customization properties have been added for better error handling control:

Full Screen Error styling (displayed when chat fails to load completely):

New Property	Description	Platform
chatFullScreenErrorTitleText	Main error title text	Both
chatFullScreenErrorTitleTextColor	Error title text color	Both
chatFullScreenErrorTitleTextAppearance	Text appearance for error title	Both
chatFullScreenErrorDescriptionText	Error description text	Both
chatFullScreenErrorDescriptionTextColor	Error description text color	Both
chatFullScreenErrorDescriptionTextAppearance	Text appearance for error description	Both
chatFullScreenErrorBackgroundColor	Error screen background color	Both
chatFullScreenErrorIcon	Icon resource displayed on error screen	Both
chatFullScreenErrorIconTint	Tint color of error icon	Both
chatFullScreenErrorRefreshButtonText	Text for the retry/refresh button	Both
chatFullScreenErrorRefreshButtonTextColor	Refresh button text color	Both
chatFullScreenErrorRefreshButtonVisible	Whether refresh button is visible	Both

Chat Error Banner styling (displayed for chat operation errors like message send failures):

New Property	Description	Platform
chatBannerErrorTextColor	Text color for chat error banner	Both
chatBannerErrorTextAppearance	Text appearance for chat error banner	Both
chatBannerErrorBackgroundColor	Background color for chat error banner	Both
chatBannerErrorIcon	Icon resource for chat error banner	Android
chatBannerErrorIconTint	Icon tint color for chat error banner	Android

Network Connection Error enhancements:

New Property	Description	Platform
networkErrorIcon	Icon resource for network connection error snackbar	Android
networkErrorIconTint	Icon tint color for network connection error	Android

These properties provide granular control over different error types, allowing you to customize the appearance of full-screen loading errors separately from chat operation errors (like message send failures) and network connection errors.

Example:

MobileMessaging.setChatCustomization({
  // Network connection error (when internet is lost)
  networkErrorText: 'No internet connection',
  networkErrorTextColor: '#FFFFFF',
  networkErrorLabelBackgroundColor: '#000000',
  networkErrorIcon: 'path/to/network_icon.png',
  networkErrorIconTint: '#FFFFFF',

  // Chat operation errors (message send failures, API errors, etc.)
  chatBannerErrorTextColor: '#FFFFFF',
  chatBannerErrorBackgroundColor: '#FF5722',
  chatBannerErrorIcon: 'path/to/error_icon.png',
  chatBannerErrorIconTint: '#FFFFFF',

  // Full screen error (when chat fails to load completely)
  chatFullScreenErrorTitleText: 'Something went wrong',
  chatFullScreenErrorTitleTextColor: '#000000',
  chatFullScreenErrorDescriptionText: 'Try again later or contact support',
  chatFullScreenErrorDescriptionTextColor: '#666666',
  chatFullScreenErrorBackgroundColor: '#FFFFFF',
  chatFullScreenErrorIcon: 'path/to/full_error_icon.png',
  chatFullScreenErrorRefreshButtonText: 'Try Again',
  chatFullScreenErrorRefreshButtonTextColor: '#000000',
  chatFullScreenErrorRefreshButtonVisible: true,
  // ... other properties
});

Error types clarification

The In-app chat now explicitly displays three types of errors:

1. Full Screen Error - Shown when chat fails to load completely (always displayed, can only customize appearance)
2. Network Connection Error - Snackbar shown when device loses internet connectivity
3. Chat Error Banner - Banner shown for chat operation errors (new distinct styling)

For more details, see the Handle chat errors section.