CXone Chat for Android

This repository consists out of three main modules and three tooling modules, which are described in chapters below.

CXone Chat SDK

This is the only published module. It is released as an Android multi-flavor library with Maven artifact coordinates com.nice.cxone:chat-core.

Adding the Dependency

To use the published artifact, include our public Maven/Gradle GitHub repository in your project. For details, see GitHub documentation on using published packages.

In the section where you define repositories used in your project (in our case, it is settings.gradle), add this part:

    def localProperties = new Properties()
    try {
        localProperties.load(file("local.properties").newReader())
    } catch (ignored) {
        logger.trace("Unable to read local.properties")
    }
    repositories {
        maven {
            name = "github-nice-devone-cxone-mobile"
            url = "https://maven.pkg.github.com/nice-devone/nice-cxone-mobile-sdk-android"
            credentials {
                // Use property key from local.properties for local builds or environment variable for CI builds
                username = localProperties["github.user"] ?: System.getenv("GPR_USERNAME")
                password = localProperties["github.key"] ?: System.getenv("GPR_TOKEN")
            }
        }
    }

Then either add properties github.user and github.key to your local.properties e.g.:

github.user=myuser
github.key=github_my_token

or set system variables GPR_USERNAME and GPR_TOKEN. You can use any uprivilidged valid token, since the package are public.

Then you can use the dependency simply by adding:

    implementation "com.nice.cxone:chat-sdk-core:$currentVersion"

Additional information

Visit NICE documentation for more information about CXone Chat and pre-requisites for the SDK.

Current API.

You can also find a simplified example of possible SDK usage in docs/case-studies.md documentation.

We offer a brief how-to guide for integration docs/implementation.md.

CXone Chat UI

This is the default implementation of the UI for CXone Chat SDK, which allows easier integration of the SDK into the intended target application.

Chat UI provides these features:

• Display the thread list (for multi-thread SDK configuration)

• Archive an existing thread

• Start a new thread

• Display and service the thread conversation (including implementation for all currently supported message formats)

• Send message

• Upload attachment

• Record & play voice messages

• Name the thread (for multi-thread SDK configuration)

• Message pagination support

• Typing indication & reporting

• Filling out of pre-contact form

• Display notification about the new message when application is in the background (requires Firebase Cloud Messaging)

• Sharing of message attachments

• Fullscreen previews of images & videos

Store application

This is a mock application that tries to imitate e-store with its purchase flow, so we can also demonstrate an integration of the SDK analytics events like pageView or conversion.

Integration

When integrating the CXone Chat SDK into your application, please note the following:

If your application defines its own fullBackupContent rules, you must explicitly exclude the CXone SDK's shared preferences file to avoid backing up sensitive data, which are not transferable. Add the following exclusion to your backup rules:

<exclude domain="sharedpref" path="com.nice.cxonechat.secure.xml" />

This ensures that the SDK's secure preferences are not included in the application's backup and won't cause an issue if the application is restored on a different device.

Tooling modules:

logger

The logger module is a minimalistic logging framework used by the chat-sdk-core without any platform-specific code. It is distributed as a java library at the moment.

The maven artifact coordinates are com.nice.cxone:logger.

logger-android

The logger-android module provides the default android-specific implementation of the Logger. Application can provide this instance to the SDK builder if it wishes the SDK to log to the Android platform log output.

The maven artifact coordinates are com.nice.cxone:logger-android.

utilities

This is an internal module that attempts to resolve some of the issues reported by the strict mode.