Remote Command: Usabilla

To install Usabilla remote commands for iOS using CocoaPods:

1. Remove tealium-swift and pod "Usabilla" if they already exist your Podfile. The dependency for tealium-swift is already included in the TealiumUsabilla framework.

2. Add the following dependency to your Podfile:

   pod "TealiumUsabilla"

   The TealiumUsabilla pod includes the following TealiumSwift dependencies:

   'tealium-swift/Core'
   'tealium-swift/TealiumDelegate'
   'tealium-swift/TealiumRemoteCommands'
   'tealium-swift/TealiumTagManagement'

3. Add any other required modules manually to your Podfile, such as the following:

   'tealium-swift/TealiumLogger'
   'tealium-swift/TealiumLifecycle'
   'tealium-swift/TealiumAppData'

   Learn more about the recommended modules for iOS.

4. Import the modules TealiumSwift and TealiumUsabilla in your TealiumHelper file, and any other files that access the Tealium class or the Usabilla remote command.

To install Usabilla remote commands for iOS using Carthage:

1. Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumUsabilla framework.

2. Remove the following line if it exists in your Cartfile:

   github "usabilla/usabilla-u4a-ios-swift-sdk"

3. Add the following dependency to your Cartfile:

   github "tealium/tealium-ios-usabilla-remote-command"

Tealium for Swift SDK (version 1.6.5+) requires the TealiumDelegate module to be included with your installation.

To install Usabilla remote commands for Android using Maven:

1. Install Tealium’s Android SDK, if you haven’t done so already.

2. Import the Tealium-Usabilla remote commands by adding the following dependency in your app project’s build.gradle file:

   dependencies {
     implementation 'com.tealium.remotecommands:usabilla:1.0.0'
   }

Add the remote command in the TealiumHelper.swift file as follows:

let usabillaCommand = UsabillaCommand()
let usabillaRemoteCommand = usabillaCommand.remoteCommand()
tealium.addRemoteCommandID(
         "usabilla",
         description: nil,
         targetQueue: DispatchQueue.main,
         responseBlock: usabillaRemoteCommand)

Import the remote command in the TealiumHelper.m file as follows:

#import "TealiumRemoteCommandObjcApp-Swift.h"

The Swift bridging header for your target is named ending with -Swift.h. Find this by filtering for “Module Name” in your target’s build settings.

Because there are delegate methods, create a new Swift file to handle your form. See the Usabilla guildelines for using these delegate methods in an Objective-C app.

Explore the SwiftBridge.swift file to see an example. Learn more in the Apple Developer Documentation: Importing Swift Into Objective-C.

Initialize the remote command as follows:

UsabillaTracker *usabillaTracker = [[UsabillaTracker alloc] init];
UsabillaCommand *usabillaCommand = [[UsabillaCommand alloc] initWithUsabillaTracker:usabillaTracker];
TEALRemoteCommandResponseBlock usabillaRemoteCommand = [usabillaCommand remoteCommand];
[[Tealium instanceForKey:@"MY_INSTANCE"] addRemoteCommandID:@"usabilla"
        description:@"Usabilla Remote Command"
        targetQueue:dispatch_get_main_queue()
        responseBlock: usabillaRemoteCommand];

The following code is designed for use with Tealium’s Android library:

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);

RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config);
teal.addRemoteCommand(usabilla);

Additional (optional) initialization parameters are available for the Usabilla SDK:

• usabillaHttpClient = null
  Overrides the HttpClient object, which gives the possibility to inject a custom client to handle all the connections performed by the SDK. Learn more about the custom HTTP client.
• usabillaReadyCallback = null
  Overrides the UsabillaReadyCallback object, which is a callback used to communicate when the initialization process ends.
• autoFragmentManager = false
  Disables passive feedback (enabled by default). Passive feedback requires Android’s FragmentManager to be kept up-to-date and monitored using android.app.Application.ActivityLifecycleCallbacks.
• autoFeedbackHandler = false
  Disables handling of event tracking for passive and campaign feedback forms as well as auto-removing forms that have been submitted or dismissed (enabled by default). Two android.content.BroadcastReceivers are registered to listen for Usabilla events that handle both passive and campaign feedback form closures.

The following example shows usage of the optional parameters:

RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config,
        usabillaHttpClient = null,
        usabillaReadyCallback = null,
        autoFragmentManager = false,
        autoFeedbackHandler = false);

The following code is designed for use with Tealium’s Swift library for iOS:

var teal : Tealium?
let config = TealiumConfig(
       account: "ACCOUNT",
       profile: "PROFILE",
       environment: "ENVIRONMENT",
       datasource: "DATASOURCE",
       optionalData: nil)

teal = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
        return
  }
  let usabillaCommand = UsabillaCommand()
  let usabillaRemoteCommand = usabillaCommand.remoteCommand()
  remoteCommands.add(usabillaRemoteCommand)
}

The following code is designed for use with Tealium’s Objective-C library for iOS, although it is written in Swift. A Bridging Header is required in your Xcode project for this code to work correctly.

let config = TEALConfiguration(
       account: "ACCOUNT",
       profile: "PROFILE",
       environment: "ENVIRONMENT",
       datasource: "DATASOURCE")
let teal = Tealium.newInstance(forKey: "teal", configuration: config)

let usabillaCommand = UsabillaCommand()
let usabillaRemoteCommand = usabillaCommand.remoteCommand()
teal.addRemoteCommandID("usabilla", description: nil, targetQueue: DispatchQueue.main, responseBlock: usabillaRemoteCommand)