Unblu iOS Mobile SDK v4

About

The Unblu iOS Mobile SDK serves as a way to integrate the Unblu platform into native iOS apps.

Requirements

• Unblu Collaboration Server 7.x.x
• iOS 14.5+

NOTE: The iOS SDK itself is compiled to work with iOS 13. However, the minimum version supported by Unblu 7 is 14.5.

Main Classes

Unblu

The Unblu struct provides two static methods to create and begin using Unblu:

• createVisitorClient (returns an UnbluVisitorClient instance)
• createAgentClient (returns an UnbluAgentClient instance) This is the main entry point into Unblu.

UnbluClient

The UnbluClient protocol provides some of the main functionality that is available on an Unblu instance.

UnbluClientConfiguration

The UnbluClientConfiguration is a struct used to create an Unblu instance.

UnbluVisitorClient

The UnbluVisitorClient protocol inherits from UnbluClient, and provides some additional Visitor only functionality.

Use the visitorDelegate property to receive events from the UnbluVisitorClient.

UnbluAgentClient

The UnbluAgentClient protocol inherits from UnbluClient, and provides some additional Agent only functionality.

Use the agentDelegate property to receive events from the UnbluAgentClient.

UnbluNotificationApi

The UnbluNotificationApi exposes a static Singleton property, instance. Use this class for notification interactions with Unblu. Please see the documentation for more information.

Modules

All modules with the exception of the UnbluFirebaseNotificationModule are registered and unregistered using UnbluClientConfiguration.register and UnbluClientConfiguration.unregister respectively.

UnbluCallModule

To create an instance of the UnbluCallModule, use the UnbluCallModuleProvider.create method. This returns an object that is described by the UnbluCallModuleApi protocol.

UnbluCallModule requires the OpenTok/Vonage iOS SDK.

Install OpenTok/Vonage into your Xcode project using Cocoapods:

pod 'OpenTok', '~> 2.0'

UnbluMobileCoBrowsingModule

To create an instance of the UnbluMobileCoBrowsingModule, use the UnbluMobileCoBrowsingModuleProvider.create method. This returns an object that is described by the UnbluMobileCoBrowsingModuleApi protocol.

UnbluFirebaseNotificationModule

To use the UnbluFirebaseNotificationModule, please refer to the online documentation and example projects for an in-depth guide as the integration steps are beyond the scope of this document.

The two main classes of note are:

• UnbluFirebaseNotificationCoordinator
• UnbluFirebaseUIApplicationDelegate

UnbluFirebaseNotificationModule requires the iOS Firebase SDK.

Install Firebase into your Xcode project using Cocoapods:

pod 'Firebase/Core', '~> 7.0'
pod 'Firebase/Messaging'

Known Issues

• UIDocumentInteractionController will not work with Unblu co-browsing. This is because UIDocumentInteractionController is an instance of QLPreviewController and is actually rendered in a completely separate app with a separate process. It is therefore impossible for us to render any content displayed using UIDocumentInteractionController as part of co-browsing.