iOS Chatbot UI Kit

Requirements

Depends on: Enx_UIKit_iOS 2.2.4 → EnxRTCiOS 3.1.6

Installation

Option A — Swift Package Manager (binary distribution)

Build the framework via build_xcframework.sh (see Building & Distributing the Framework), upload the resulting .zip to a release, then point Enx_iOS_lib_template/Package.swift at it:

.binaryTarget(
    name: "dialogs_ChatbotAV_iOS",
    url: "https://github.com/<org>/<repo>/releases/download/1.0.0/dialogs_ChatbotAV_iOS.xcframework.zip",
    checksum: "<value from Enx_iOS_lib/checksum.txt>"
)

Option B — CocoaPods

Use Enx_iOS_lib_template/dialogs_ChatbotAV_iOS.podspec, which vendors the same .xcframework via s.vendored_frameworks and an HTTP source pointing at the release zip.

Required Permissions MANDATORY

Reference values used in the sample host app (VCX_Chat_Bot target build settings):

INFOPLIST_KEY_NSCameraUsageDescription = "App User Camera for image capture";
INFOPLIST_KEY_NSMicrophoneUsageDescription = "App User micro Phone";
INFOPLIST_KEY_NSPhotoLibraryUsageDescription = "Select image from galary";

Integration Steps

1. Add the framework via SPM or CocoaPods (see Installation above).
2. Add the three usage-description keys from Required Permissions to your app's Info.plist.
3. Build an EnxBotConfiguration with your bot id/host, call EnxChatClient.connect(configuration:eventListner:), and attach the returned view — see the Usage Example.
4. If you set callingView: true, also call EnxChatClient.getCallingView() and place the returned control in your own chrome (toolbar/nav bar).
5. Test all calling and attachment flows on a physical device — see Requirements.

EnxChatClient final class

The single entry point into the UI Kit. All members are static — the framework manages one active bot session per process.

static func connect(configuration: EnxBotConfiguration, eventListner delegate: EnxChatClientDelegate) -> EnxBotContainerView

Starts a bot session and returns the container view to attach into your view hierarchy. Internally creates the WebView-backed chat engine, wires it to the given EnxBotConfiguration, and stores delegate for the didBotConnected callback.

static func getCallingView() -> EnxCallingView

Returns a standalone audio/video call-trigger control (a UIStackView with an audio and a video button). Only meaningful after connect(configuration:eventListner:) has been called with configuration.callingView == true — the returned view reflects that configuration's callingView flag.

EnxChatClientDelegate protocol

func didBotConnected(_ botInfo: [String: Any])

Called once when the remote bot session identifies itself. botInfo is the raw botInfo payload forwarded from the chatbot web application (bot name, metadata, etc.) — shape is defined by the bot backend, not this SDK.

EnxBotConfiguration open class

Immutable configuration object passed to EnxChatClient.connect.

public init(botId: String, host: String, path: String = "", callingView: Bool = false)

EnxBotContainerView final class : UIView

The root view returned by connect(configuration:eventListner:). Owns the chat list, input bar, click-to-call UI, WebView engine, and (on demand) the floating video call surface.

func attach(to parent: UIView)

Convenience helper that pins the container to parent's safe-area top and its leading/trailing/bottom edges via Auto Layout. Use your own constraints instead if you need custom placement.

func resetBot()

Clears the remote conversation state (invokes the web engine's resetConversation / clearConversation / reset, whichever the loaded bot script exposes).

EnxBotContainerView also conforms to PHPickerViewControllerDelegate, UIImagePickerControllerDelegate, and UIDocumentPickerDelegate so it can directly receive attachment picker callbacks — these conformances are implementation detail exposed only because Objective-C delegate protocols require public visibility; they are not meant to be invoked directly by host apps.

EnxCallingView final class : UIStackView

A two-button (audio / video) call trigger control, obtained via EnxChatClient.getCallingView(). Place it in your own toolbar/header when using callingView: true mode. Tapping a button routes the corresponding CallType back into the active EnxBotContainerView's call-handling pipeline.

EnxChatSetting final class : NSObject

EnxChatSetting.shared is a public singleton, but its sessionId, conversationId, and botInfo members are internal — there is currently no actionable public surface on this type for host apps. It is documented here only for completeness; do not depend on it from outside the framework.

Usage Example

import UIKit
import dialogs_ChatbotAV_iOS

final class ChatViewController: UIViewController, EnxChatClientDelegate {

    override func viewDidLoad() {
        super.viewDidLoad()

        let configuration = EnxBotConfiguration(
            botId: "<your-bot-id>",
            host: "<your-bot-host>",
            callingView: false
        )

        let botView = EnxChatClient.connect(
            configuration: configuration,
            eventListner: self
        )
        botView.attach(to: view)
    }

    func didBotConnected(_ botInfo: [String: Any]) {
        print("Bot connected:", botInfo)
    }
}

What Your Users See

Because the UI Kit renders a complete, ready-made chat and calling experience, it helps to know exactly what your end users will interact with. The walkthrough below is adapted from the UI Kit's own end-user guide — useful for support teams, QA, and anyone writing in-app help content.

1. Starting a Conversation

The chat screen opens ready to talk — there's nothing to set up. A greeting from the assistant appears automatically, and the user can start typing right away in the message box at the bottom of the screen.

• If the assistant is still starting up, a typing indicator (three dots) briefly appears before the first message arrives.
• If the chat doesn't load at all, it's usually a connectivity issue — the assistant needs a live connection to respond.

2. Sending Messages

Illustration pending — place chatbot-uikit-ios-chat-screen.png in assets/img/dialogs/

The user types in the message box and taps the send button (the arrow icon) to reply to the assistant. User messages appear on the right in blue; the assistant's replies appear on the left. The assistant can also send:

• Formatted text — bold and other simple formatting render automatically.
• Images, video clips, and files it wants to share.
• A date picker, for questions like scheduling an appointment.
• Quick-reply chips (see below) and action buttons that open a link when tapped.

3. Quick Replies & Suggestions

When the assistant offers a set of rounded buttons under its message, the user taps one instead of typing — it sends that reply automatically. Some questions allow picking only one option; others let the user pick several before continuing.

4. Sharing Photos, Videos & Files

Tapping the + button to the left of the message box opens the attachment panel:

• Camera — take a new photo to send immediately.
• Photo Library — pick an existing photo from the device.
• Video — pick a video from the library.
• File — share a document (PDF, text, or other file types).

The first time each option is used, the device asks for permission to access the camera, photo library, or microphone — see About the Permission Prompts below.

5. Starting a Call

For some conversations, the assistant offers to connect the user to a live agent by phone or video instead of continuing over text. When that happens, the message box is replaced with a call screen:

Illustration pending — place chatbot-uikit-ios-click-to-call.png in assets/img/dialogs/

Tapping the video icon starts connecting. The label under the button keeps the user informed:

6. During the Call

Once connected, the call opens full-screen with the agent's video (or just audio, depending on what was requested). The user can keep using the rest of the app while a call is active by shrinking it into a small floating window:

Illustration pending — place chatbot-uikit-ios-video-call-pip.png in assets/img/dialogs/

• Shrink the call: tap the small icon in the top-right corner of the call screen to collapse it into a floating window.
• Move the floating window: drag it anywhere on the screen — it stays out of the way.
• Return to full screen: tap the floating window to expand it again.
• End the call: tap the red button to hang up.

7. About the Permission Prompts

The app asks for a few permissions the first time certain features are used. These are standard iOS prompts, and the user can always change the answer later in Settings for the app.

If a permission is declined and the user later wants that feature, they can open iOS Settings → [app name] → and turn the relevant permission back on.

8. End-User Troubleshooting

Feature Support (v1.0.0)

Building & Distributing the Framework

The repository ships a single consolidated script, build_xcframework.sh, that works two ways:

• Manual: bash build_xcframework.sh from the repo root — archives the dialogs_ChatbotAV_iOS scheme for a real device and packages the result.
• Automatic: already wired into the scheme's Archive Post-action (VCX_Chat_Bot.xcodeproj/xcshareddata/xcschemes/dialogs_ChatbotAV_iOS.xcscheme) — running Product › Archive on that scheme in Xcode packages the archive automatically, with no extra setup.

Both paths write to Enx_iOS_lib/: dialogs_ChatbotAV_iOS.xcframework, the matching .zip, a standalone dSYMs/ copy for crash symbolication, and checksum.txt for SPM's binary target checksum.

Developer Troubleshooting