Configuration of the Unblu Collaboration Server for the Unblu mobile SDKs

The following configuration properties are important for the mobile SDKs:

com.unblu.messenger.mobileVisitorSdkEnabled: Specifies whether the mobile SDK’s visitor API is enabled. This must be enabled to initialize the SDK’s visitor API on a mobile device. If the property is set to false, you can’t use the visitor API.
com.unblu.messenger.mobileAgentSdkEnabled: Specifies whether the mobile SDK’s agent API is enabled. This must be enabled to initialize the SDK’s agent API on a mobile device. If the property is set to false, you can’t use the agent API.
com.unblu.messenger.mobileCoBrowsingEnabled: Specifies whether mobile co-apping with the SDKs is enabled. If it isn’t enabled, the SDKs can still be used for chat or call conversations.
com.unblu.conversation.feature.mobileCoBrowsingEnabled: The same as messenger.mobileCoBrowsingEnabled but at a conversation level. This property may be set individually for each conversation and conversation template.
com.unblu.messenger.startWithMobileCobrowsingOptionEnabled: Enables starting a mobile co-apping conversation. Such a conversation immediately launches mobile co-apping when the conversation is accepted from the queue.
com.unblu.visitor.ui.engagement.showRequestMobileCobrowsingEngagementOption: If set to true, the UI gives you the option to start a mobile co-apping conversation when displaying the Unblu UI in your app.

Collaboration Server and mobile SDK compatibility

Releases of the Collaboration Server and the mobile SDKs don’t take place at the same time. To determine whether a particular version of the Collaboration Server is compatible with a particular version of one of the SDKs, follow the guidelines below:

The principle component is the Collaboration Server. Releases of the mobile SDK are compatible with the latest version of the Collaboration Server available when the mobile SDK is released.
A mobile SDK version remains compatible with minor versions of the Collaboration Server released after the mobile SDK was released.
Once an SDK reaches the end of its support period, there is no guarantee that it will remain compatible with new minor versions of the Collaboration Server.

Consider the following example: Android mobile SDK 3.4.2 was released on 14 June 2021. At the time, the latest version of the Collaboration Server was 6.35.0, which was released on 11 June 2021. As a result, Android SDK 3.4.2 is compatible with 6.35.0 and subsequent minor and major versions of Unblu. This is the case until 29 August 2023, when the support period for version 3 of the mobile SDKs ends.

There are no guarantees that Android mobile SDK 3.4.2 is compatible with version 6.34.4 of the Collaboration Server, which was released on 21 May 2021, or earlier versions of the Collaboration Server.

Mobile push notifications

The following configuration properties must be set for mobile devices to be able to send and receive mobile push notifications from the Unblu server via Firebase Cloud Messaging:

com.unblu.core.push_notification.enablePushNotification: Enables push notifications in general. Currently there are email and mobile push notifications.
com.unblu.mobile.push_notification.enablePushNotification: Enables push notifications via Firebase Cloud Messaging. If set to true, com.unblu.core.push_notification.enablePushNotification must also be set to true.
com.unblu.mobile.push_notification.firebaseDatabaseName: The name of the firebase project ID—not the firebase database; Unblu doesn’t need the firebase database—where the app is configured for Firebase Cloud Messaging. Set the property to the Project ID of your Firebase project, as displayed on the General tab of your Firebase project’s settings.
com.unblu.mobile.push_notification.firebaseServiceAccountKey: The account key to allow the Unblu server to access Firebase Cloud Messaging. You can generate an account key by clicking the Generate new private key button on the Service accounts tab in the settings of your Firebase project.
com.unblu.mobile.push_notification.enableApnsPushKitCallNotification: Enables push notifications to iOS devices with the Apple Push Notification service (APNs). If true, com.unblu.mobile.push_notification.enablePushNotification must also be true.

For more information, refer to iOS Voice over IP (VoIP) call notification below.

For more information on Firebase Cloud Messaging, refer to the Firebase documentation. Depending on the operating system you are targeting, review the Firebase documentation on setting up a Firebase Cloud Messaging client on Android or iOS.

OS-specific information is available in the articles on Android and iOS integration, respectively.

Mobile push notifications using webhooks

Besides Firebase and APNs, Unblu also lets you use your own push notification middleware to send push notifications to mobile devices.

All push_notification webhooks that the Unblu web API sends include a field called ìnternalMobilePushNotificationData.

Your push notification service must pass on the contents of the field to your mobile clients, which must in turn pass it to the Unblu mobile SDKs as is. The Unblu mobile SDKs can then display push notifications on your users' mobile devices.

iOS Voice over IP (VoIP) call notifications

The following configuration properties need to be set for iOS mobile devices to be able to send mobile PushKit notifications that trigger an incoming call dialog box from the Unblu server via APNs (Apple Push Notification service):

com.unblu.mobile.push_notification.apnsPushKitBundleId: Your visitor app’s bundle ID with the extension .voip
com.unblu.mobile.push_notification.apnsAgentPushKitBundleId: Your agent app’s bundle ID with the extension .voip
com.unblu.mobile.push_notification.apnsPushKitKey: The APNs authentication key
com.unblu.mobile.push_notification.apnsKeyId: The APNs authorization key identifier
com.unblu.mobile.push_notification.apnsTeamId: The team ID of your Apple Developer account
com.unblu.mobile.push_notification.enableApnsProductionEndpoint: Specifies whether to use production APNs or a so-called "sandbox" for testing.

For more information on sending notification requests to APNs, refer to Apple’s APNs documentation. You can find information about PushKit notifications here.

You can embed Unblu within other elements, but you can’t add external views to the Unblu view element.

Color mode

This is a preview feature. It may be subject to change or removal with no further notice.

To enable preview features, set com.unblu.platform.enablePreview to true.

For more information on preview features, refer to the Unblu release policy.

The Unblu UI in your app supports light and dark color modes. For an introduction to color mode, the color scheme values, and configuring dark colors, refer to the Color mode article.

You can set the mobile UI color scheme with com.unblu.agent.mobile.ui.colorScheme for agents and com.unblu.visitor.mobile.ui.colorScheme for visitors. Both properties take the values light, dark, and auto. If you don’t set them, the mobile UIs use the central com.unblu.theme.color.colorScheme value.

Overriding the color scheme from your app

Your app can override the configured color scheme at runtime by calling setColorScheme on the Unblu client. An app override takes precedence over the server configuration.

Table 1. How Unblu determines the applied color scheme
App override	Server configuration	Device appearance	Applied color scheme
Not set	`light`	Any	Light
Not set	`dark`	Any	Dark
Not set	`auto`	Light	Light
Not set	`auto`	Dark	Dark
`light`	Any	Any	Light
`dark`	Any	Any	Dark
`auto`	Any	Light	Light
`auto`	Any	Dark	Dark

How long an override lasts, and which parts of the UI adopt the new color scheme, differ between the two platforms. For more information, refer to Color mode in the Android mobile SDK article and Color mode in the iOS mobile SDK article.

When a color scheme change takes effect

Whether a color scheme change applies immediately depends on the com.unblu.theme.color.colorSchemeEvaluationMode property.

With the default dynamic evaluation, the UI changes color scheme without reloading.
With static evaluation, Unblu applies the appropriate color scheme when the UI loads. The color scheme stays fixed after that. Calling setColorScheme has no effect on it. Reloading the Unblu UI doesn’t have an effect either, because on reload, the SDK takes the color scheme from the server configuration rather than from your app.

The evaluation mode only affects the parts of the Unblu UI that the SDKs render in a WebView. For the native parts, the Unblu server always sends both a light and a dark value for each color. Those parts therefore follow the applied color scheme whatever the evaluation mode.

WebViews that don’t support the CSS light-dark() function fall back to static evaluation.

For more information, refer to Evaluation modes.