Skip to content

nice-devone/nice-cxone-mobile-ui-ios

Repository files navigation

CXoneChatUI

The CXoneChatUI module provides a default implementation of a Chat User Interface (UI) for the CXoneChat Sample application. This module is designed to handle both single- and multi-threaded channel configurations, offering seamless integration into your iOS application.

Requirements

  • iOS 15.0+
  • Swift 5+

## Modules

  • Core
  • UI (⚠️ still under development, not yet actively supported)
  • Sample app

Getting Started

To integrate the CXoneChatUI module into your project, follow these steps:

Step 1: Import CXoneChatUI

Include the CXoneChatUI module in your project. You can do this by adding the following line to your project's dependencies:

import CXoneChatUI

Step 2: Use DefaultChatCoordinator

Initialize and use the DefaultChatCoordinator to start the chat functionality. This coordinator simplifies the setup process and provides a quick way to integrate the chat UI into your application.

let chatCoordinator = DefaultChatCoordinator()
// (optional) Specify Chat Style of colors or brand logo in the chat navigation bar
chatCoordinator.style = ChatStyle(backgroundColor: .accentColor)
...
chatCoordinator.start()

Also, it is possible to setup deeplinking for the Chat to enter specifinc thread for multi-threaded channel configuration.

chatCoordinator.start(deeplinkOption: .thread(threadIdOnExternalPlatform))

Features

Single-Threaded Channel Configuration

The CXoneChatUI module seamlessly supports single-threaded channel configurations. This allows users to engage in one-on-one conversations with ease.

Multi-Threaded Channel Configuration

For scenarios involving multiple threads or group conversations, the CXoneChatUI module provides a smooth experience. Users can navigate and participate in multi-threaded discussions effortlessly.

LiveChat Channel Configuration

The CXoneChatUI module offers robust live chat functionalities, enabling real-time communication between agents and mobile customers.

Customization

The UI module currently allows to customize online colors and set the brand logo in the navigation bar. By default, the color scheme is predefined and it is not necessary to take care of that.

License

CXoneChatUI is released under the MIT License. Feel free to use, modify, and distribute it according to the terms of this license.