Remote Command: Airship | Integrations | Preview of Tealium Docs

Requirements

Airship credentials
One of these mobile libraries:
- Tealium for Android
- Tealium for iOS-Swift
Airship Remote Command tag in Tealium iQ Tag Management

How It Works

The Airship integration uses three items:

The Airship native SDK
The Tealium Airship remote commands module that wraps the Airship methods
The Airship Remote Command tag that translates event tracking into native Airship calls

When you add the Airship remote command module to your app, the required Airship libraries are automatically installed without adding any vendor-specific code to your app. There is no need to install the Airship SDK separately.

Install

Dependency Manager

Swift Package Manager is the recommended and simplest way to install the TealiumAirship package. To install Airship remote commands for iOS using Swift Package Manager:

In your Xcode project, select File > Add Packages… > Add Package Dependency
Enter the repository URL: https://github.com/tealium/tealium-ios-airship-remote-command
Configure the version rules. Typically, Up to next major is recommended. If the current TealiumAirship version does not appears in the list, then reset your Swift package cache.
Select the TealiumAirship module to install, and select the app target you want the module to be installed in.
If you are using any additional modules from the Tealium Swift library, follow the Swift Package Manager instructions to add them.

If your project has more than one app target and needs TealiumAirship module in more app targets, you have to manually add them in the Frameworks, Libraries, and Embedded Content section.

To install TealiumAirship in additional app targets:

Select your Xcode project in the Project Navigator.
In your Xcode project, select the app target under the TARGETS section.
Navigate to General > Frameworks, Libraries & Embedded Content and select the TealiumAirship module to add it to your app target.

Remove pod "tealium-swift" and pod "Airship" if they exist in your Podfile. The dependency for tealium-swift is already included in the TealiumAirship framework.
Add the following dependency to your Podfile:
```
pod "TealiumAirship"
```
The TealiumAirship pod includes the following TealiumSwift dependencies:
```
"tealium-swift/Core"
"tealium-swift/RemoteCommands"
"tealium-swift/TagManagement"
```
Add any other required modules manually to your Podfile, such as the following:
```
pod "tealium-swift/Lifecycle"
pod "tealium-swift/VisitorService"
```
Learn more about the recommended modules for iOS.
Import the modules TealiumSwift and TealiumAirship in your TealiumHelper file, and any other files that access the Tealium class, or the Airship remote command.

Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumAirship framework.
Remove the following line if it exists in your Cartfile:
```
github "urbanairship/ios-library"
```

Add the following dependency to your Cartfile:

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

Install Tealium for Android and add the Tealium Maven URL to your project’s top-level build.gradle file, if you haven’t done so already.

allprojects {
  repositories {
    mavenCentral()
    maven {
      url "https://maven.tealiumiq.com/android/releases/"
    }
  }
}

Import the Tealium-Airship remote commands by adding the following dependencies in your app project’s build.gradle file:
```
dependencies {
      implementation 'com.tealium.remotecommands:airship:1.1.0'
}
```

Manual Installation

The manual installation for Airship remote commands requires the Tealium for Swift library to be installed. To install the Airship remote commands for your iOS project:

Install the Airship SDK, if you haven’t already done so.
Clone the Tealium iOS Airship remote command repo and drag the files within the Sources folder into your project.
Add Dispatchers.RemoteCommands as a dispatcher.
Set the remoteAPIEnabled configuration flag to true.

The manual installation for Airship remote commands requires Tealium for Android (Kotlin) or Tealium for Android (Java) to be installed. To install the Airship remote commands for your Android project:

Add flatDir to your project root build.gradle file:

repositories {
    flatDir {
        dirs ('/src/main/libs')
    }
}

Add tealium-airship.aar to <PROJECT_ROOT>/<MODULE>/libs.

Add the Tealium library dependency to your build.gradle file:

dependencies {
      implementation(name:'tealium-airship', ext:'aar')
}

Initialize

Initialize remote commands with a JSON configuration file or the Remote Command tag for Tealium’s Android or Swift library.

The following example creates a Tealium instance and then registers the Airship remote command with Tealium’s Swift library for iOS:

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE")
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // Required to use Remote Commands

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }

    // Webview Tag
    let airship = AirshipRemoteCommand() 

    // Local JSON
    //let airship = AirshipRemoteCommand(type: .local(file: "airship"))

    // Remote JSON
    //let airship = AirshipRemoteCommand(type: .remote(url: "https://some.domain.com/airship.json"))
    remoteCommands.add(airship)
}

The following example creates a Tealium instance and then registers the Airship remote command for Android (Kotlin):

val config = TealiumConfig(application,
        "ACCOUNT",
        "PROFILE",
        Environment.DEV,
        dispatchers = mutableSetOf(Dispatchers.RemoteCommands, Dispatchers.TagManagement));
val airship = AirshipRemoteCommand(application);

var tealium = Tealium.create(TEALIUM_MAIN, config) {

    // Webview Tag
    remoteCommands?.add(airship);

    // Local JSON
    //remoteCommands?.add(airship, filename = "airship.json");

    // Remote JSON
    //remoteCommands?.add(airship, remoteUrl = "https://some.domain.com/airship.json"); 
}

Supported Methods

We map a command to each Airship method. To trigger an Airship method, pass the corresponding command in the specified format.

Remote Command	Airship Method
`initialize`	`takeOff()`
`trackevent`	`UACustomEvent.track()`
`trackscreenview`	`trackScreen`
`enableanalytics`	`analytics()?.isEnabled`
`disableanalytics`	`analytics()?.isEnabled`
`setnameduser`	`UAirship.namedUser()?.identifier`
`setcustomidentifiers`	`analytics()?.associateDeviceIdentifiers`
`enableadvertisingidentifiers`	`analytics()?.associateDeviceIdentifiers`
`enableinappmessaging`	`UAInAppMessageManager.shared()?.isEnabled`
`disableinappmessaging`	`UAInAppMessageManager.shared()?.isEnabled`
`pauseinappmessaging`	`UAInAppMessageManager.shared()?.isPaused`
`unpauseinappmessaging`	`UAInAppMessageManager.shared()?.isPaused`
`setinappmessagingdisplayinterval`	`UAInAppMessageManager.shared()?.displayInterval`
`enableuserpushnotifications`	`UAirship.push()?.userPushNotificationsEnabled`
`disableuserpushnotifications`	`UAirship.push()?.userPushNotificationsEnabled`
`enablebackgroundpushnotifications`	`UAirship.push()?.backgroundPushNotificationsEnabled`
`disablebackgroundpushnotifications`	`UAirship.push()?.backgroundPushNotificationsEnabled`
`setpushnotificationoptions`	`UAirship.push()?.notificationOptions`
`setforegroundpresentationoptions`	`UAirship.push()?.defaultPresentationOptions`
`setbadgenumber`	`UAirship.push()?.badgeNumber`
`resetbadgenumber`	`UAirship.push()?.resetBadge()`
`enableautobadge`	`UAirship.push()?.isAutobadgeEnabled`
`disableautobadge`	`UAirship.push()?.isAutobadgeEnabled`
`enablequiettime`	`UAirship.push()?.isQuietTimeEnabled`
`disablequiettime`	`UAirship.push()?.isQuietTimeEnabled`
`setquiettimestart`	`UAirship.push()?.setQuietTimeStartHour`
`setchanneltags`	`UAirship.channel()?.tags`
`setnamedusertags`	`UAirship.namedUser()?.setTags()`
`addtag`	`UAirship.channel()?.addTag()`
`removetag`	`UAirship.channel()?.removeTag`
`addtaggroup`	`UAirship.channel()?.addTags, UAirship.namedUser()?.addTags`
`removetaggroup`	`UAirship.channel()?.removeTags, UAirship.namedUser()?.removeTags`
`setattributes`	`UAirship.channel()?.apply`
`displaymessagecenter`	`UAMessageCenter.shared().display()`
`setmessagecentertitle`	`UAMessageCenter.shared()?.defaultUI.title`
`setmessagecenterstyle`	`UAMessageCenter.shared().defaultUI.style`
`enablelocation`	`UALocation.shared().isLocationUpdatesEnabled`
`disablelocation`	`UALocation.shared().isLocationUpdatesEnabled`
`enablebackgroundlocation`	`UALocation.shared().isBackgroundLocationUpdatesAllowed`
`disablebackgroundlocation`	`UALocation.shared().isBackgroundLocationUpdatesAllowed`

Since the Airship SDK is integrated with the Tealium SDK, you can trigger any native Airship functionality by calling the SDK directly, even if the functionality is not provided by the Tealium Airship Remote Command tag.

SDK Setup

Initialize

The Airship SDK is initialized automatically upon launch. The Airship API keys are set in the tag configuration.

Remote Command	Airship Method
`initialize`	`takeOff()`

Possible UAConfig parameters

Parameter	Type	Example
`productionAppKey` (required)	`String`	`MyProdKey`
`productionAppSecret` (required)	`String	MyProdSecret`
`developmentAppKey` (required)	`String`	`MyDevKey`
`developmentAppSecret` (required)	`String`	`MyDevSecret`
`site` (optional)	`String`	`eu/us`
`isDataCollectionOptInEnabled` (optional)	`Boolean`	`true`
`isInProduction` (optional)	`Boolean`	`true`
`developmentLogLevel` (optional)	`String`	`debug/error/info/none/trace/undefined/warn`
`productionLogLevel` (optional)	`String`	`debug/error/info/none/trace/undefined/warn`
`isAnalyticsEnabled` (optional)	`Boolean`	`true`

Airship Developer Guide: Initial SDK Setup

iOS
Android

trackEvent

Sends a custom event to Airship.

Remote Command	Airship Method
`trackEvent`	`UACustomEvent.track()`

Parameter	Type	Example
`event_name` (required)	`String`	`Purchase`
`event` (optional)	`JSON object`	`{"my_numeric_property": 1}`
`event_value` (optional)	`Number`	`1.5`

Airship Developer Guide: Event Tracking

iOS
Android

trackScreenView

Tracks a screen view.

Remote Command	Airship Method
`trackScreenView`	`UAirship.analytics()?.trackScreen`

Parameter	Type	Example
`screen_name` (required)	`String`	`Home Screen`

Airship Developer Guide: Event Tracking

iOS
Android

enableAnalytics

Enables Airship Analytics after previously being disabled (default is enabled).

Remote Command	Airship Method
`enableAnalytics`	`UAirship.analytics()?.isEnabled`

Airship Developer Guide: Enable Analytics

iOS
Android

disableAnalytics

Disables Airship Analytics after previously being enabled (default is enabled).

Remote Command	Airship Method
`disableAnalytics`	`UAirship.analytics()?.isEnabled`

Airship Developer Guide: Disable Analytics

iOS
Android

setNamedUser

Sets a known user identifier for the current app user.

Remote Command	Airship Method
`setNamedUser`	`UAirship.namedUser()?.identifier`

Parameter	Type	Example
`named_user_identifier` (required)	`String`	`email@tealium.com`

Airship Developer Guide: Event Tracking

iOS
Android

setCustomIdentifiers

Sets any additional custom identifiers that you deem significant for the user.

Remote Command	Airship Method
`setCustomIdentifiers`	`UAirship.analytics()?.associateDeviceIdentifiers`

Parameter	Type	Example
`custom` (required)	`JSON Object` (Strings Only)	`{"my_custom_identifier":"user@email.com"}`

Airship Developer Guide:

iOS
Android

enableAdvertisingIdentifiers

Adds advertising identifiers to the dictionary of custom identifiers (IDFV, IDFA, Ad Tracking Enabled.

Remote Command	Airship Method
`setCustomIdentifiers`	`UAirship.analytics()?.associateDeviceIdentifiers`

Airship Developer Guide:

iOS
Android

enableInAppMessaging

Enables the in-app messaging feature.

Remote Command	Airship Method
`enableInAppMessaging`	`UAInAppMessageManager.shared()?.isEnabled`

Airship Developer Guide:

iOS
Android

disableInAppMessaging

Disables the in-app messaging feature.

Remote Command	Airship Method
`disableInAppMessaging`	`UAInAppMessageManager.shared()?.isEnabled`

Airship Developer Guide:

iOS
Android

pauseInAppMessaging

Enables the in-app messaging feature.

Remote Command	Airship Method
`pauseInAppMessaging`	`UAInAppMessageManager.shared()?.isPaused`

Airship Developer Guide:

iOS
Android

unPauseInAppMessaging

Enables the in-app messaging feature.

Remote Command	Airship Method
`unPauseInAppMessaging`	`UAInAppMessageManager.shared()?.isPaused`

Airship Developer Guide:

iOS
Android

setInAppMessagingDisplayInterval

The amount of time Airship must wait before displaying a new in-app message, in seconds.

Remote Command	Airship Method
`setInAppMessagingDisplayInterval`	`UAInAppMessageManager.shared()?.displayInterval`

Parameter	Type	Example
`in_app_messaging_display_interval` (required)	`String`	`"10"`

Airship Developer Guide:

iOS
Android

enableUserPushNotifications

Enables user push notifications.

Remote Command	Airship Method
`enableUserPushNotifications`	`UAirship.push()?.userPushNotificationsEnabled`

Parameter	Type	Example
`push_notification_options` (optional)	`Array of Strings`	`["badge", "sound", "announcement"]`
Possible Push Messaging Options: `"badge"`, `"sound"`, `"alert"`, `"carplay"`, `"announcement"`, `"critical"`, `"app_notification_settings"`

Airship Developer Guide:

iOS
Android

disableUserPushNotifications

Disables user push notifications.

Remote Command	Airship Method
`enableUserPushNotifications`	`UAirship.push()?.userPushNotificationsEnabled`

Airship Developer Guide:

iOS
Android

enableBackgroundPushNotifications

Enables background push notifications.

Remote Command	Airship Method
`enableUserPushNotifications`	`UAirship.push()?. backgroundPushNotificationsEnabled`

Airship Developer Guide:

iOS
Android

disableBackgroundPushNotifications

Disables background push notifications.

Remote Command	Airship Method
`disableBackgroundPushNotifications`	`UAirship.push()?.backgroundPushNotificationsEnabled`

Airship Developer Guide:

iOS
Android

setPushNotificationOptions

Sets push notification options. iOS Only.

Remote Command	Airship Method
`setPushNotificationOptions`	`UAirship.push()?.notificationOptions`

Parameter	Type	Example
`push_notification_options` (required)	`Array of Strings`	`["badge", "sound", "announcement"]`

Possible Push Messaging Options: "badge", "sound", "alert", "carplay", "announcement", "critical", "app_notification_settings"

Airship Developer Guide:

setForegroundPresentationOptions

Sets push notification presentation options. iOS Only.

Remote Command	Airship Method
`setForegroundPresentationOptions`	`UAirship.push()?.defaultPresentationOptions`

Parameter	Type	Example
`foreground_presentation_options` (required)	`Array of Strings`	`["badge", "sound", "alert"]`

Possible Foreground Presentation Options: "badge", "sound", "alert"

Airship Developer Guide:

setBadgeNumber

Sets badge number on your app’s icon to a specified number. iOS Only.

Remote Command	Airship Method
`setBadgeNumber`	`UAirship.push()?.badgeNumber`

Parameter	Type	Example
`badge_number` (required)	`Number`	`3`

Airship Developer Guide:

resetBadgeNumber

Resets the badge number. iOS Only.

Remote Command	Airship Method
`setBadgeNumber`	`UAirship.push()?.badgeNumber`

Airship Developer Guide:

enableAutoBadge

Enables the auto-badge feature. iOS Only.

Remote Command	Airship Method
`enableAutoBadge`	`UAirship.push()?.isAutobadgeEnabled`

Airship Developer Guide:

disableAutoBadge

Disables the auto-badge feature. iOS Only.

Remote Command	Airship Method
`disableAutoBadge`	`UAirship.push()?.isAutobadgeEnabled`

Airship Developer Guide:

enableQuietTime

Enables the quiet time feature. iOS Only.

Remote Command	Airship Method
`enableAutoBadge`	`UAirship.push()?.isQuietTimeEnabled`

Airship Developer Guide:

disableQuietTime

Disables the quiet time feature. iOS Only.

Remote Command	Airship Method
`disableAutoBadge`	`UAirship.push()?.isQuietTimeEnabled`

Airship Developer Guide:

setQuietTimeStart

Sets the time constraints for the Quiet Time feature. iOS only.

Remote Command	Airship Method
`setQuietTimeStart`	`UAirship.push()?.isQuietTimeEnabled`

Parameter	Type	Example
`quiet` (required)	`JSON Object`	`{'start_hour': 3, 'start_minute': 30, 'end_hour': 4, 'end_minute': 30`
Required within the quiet object:

Parameter	Type	Example
`start_hour` (required)	`Number`	`3`
`start_minute` (required)	`Number`	`30`
`end_hour` (required)	`Number`	`4`
`end_minute` (required)	`Number`	`30`

Airship Developer Guide:

setChannelTags

Calls the updateRegistration function. Must be called after changing notification options. iOS Only.

Remote Command	Airship Method
`updateRegistration`	`UAirship.push()?.updateRegistration`

Airship Developer Guide:

setNamedUserTags

Sets tags for the named user, overwriting previously set tags.

Remote Command	Airship Method
`setNamedUserTags`	`UAirship.channel()?.addTags`

Parameter	Type	Example
`named_user_tags` (required)	`String Array`	`["silver-member", "gold-member"]`
`tag_group` (required)	`String`	`loyalty`

Airship Developer Guide:

iOS
Android

addTag

Adds a channel tag.

Remote Command	Airship Method
`addTag`	`UAirship.channel()?.addTag`

Parameter	Type	Example
`channel_tag` (required)	`String`	`"a_tag"`

Airship Developer Guide:

iOS
Android

removeTag

Removes a channel tag.

Remote Command	Airship Method
`removeTag`	`UAirship.channel()?.removeTag`

Parameter	Type	Example
`channel_tag` (required)	`String`	`"a_tag"`

Airship Developer Guide:

iOS
Android

addTagGroup

Adds a tag group for a named user or channel.

Remote Command	Airship Method
`addTagGroup`	`UAirship.channel()?.addTags`

Parameter	Type	Example
`named_user_tags`	`channel_tags` (required)	`String Array`
`tag_group` (required)	`String`	`loyalty`
`tag_type` (required)	`String`	`channel

Airship Developer Guide:

iOS
Android

removeTagGroup

Removes a tag group for a named user or channel.

Remote Command	Airship Method
`removeTagGroup`	`UAirship.channel()?.removeTags`

Parameter	Type	Example
`named_user_tags`	`channel_tags` (required)	`String Array`
`tag_group` (required)	`String`	`loyalty`
`tag_type` (required)	`String`	`channel`

Airship Developer Guide:

iOS
Android

setAttributes

Sets custom attributes.

Remote Command	Airship Method
`setAttributes`	`UAirship.channel()?.apply`

Parameter	Type	Example
`attributes` (required)	`JSON object`	`{"last\_product\_purchased": "A1234567"}`

Attribute values must be either Strings or Numbers.

Airship Developer Guide:

iOS
Android

displayMessageCenter

Displays the message center.

Remote Command	Airship Method
`displayMessageCenter`	`UAMessageCenter.shared().display`

Airship Developer Guide:

iOS
Android

setMessageCenterTitle

Sets the message center title. iOS only.

Remote Command	Airship Method
`setMessageCenterTitle`	`UAMessageCenter.shared().defaultUI.title`

Parameter	Type	Example
`message_center_title` (required)	`String`	`"Custom Message Center"`

Airship Developer Guide:

setMessageCenterStyle

Sets the message center style. iOS only.

Remote Command	Airship Method
`setMessageCenterStyle`	`UAMessageCenter.shared().defaultUI.style`

Parameter	Type	Example
`message_center_style` (required)	`JSON object`	Example below

{"titleFont": {"size": Double, "name":"fontname"},
 "cellTitleFont": {"size": Double, "name":"fontname"},
 "cellDateFont": {"size": Double, "name":"fontname"},
 "navigationBarColor": {"red": Double, "green": Double, "blue": Double, "alpha": Double}
 "titleColor": {"red": Double, "green": Double, "blue": Double, "alpha": Double}
 "tintColor": {"red": Double, "green": Double, "blue": Double, "alpha": Double}
 }

Airship Developer Guide:

enableLocation

Enables Location.

Remote Command	Airship Method
`enableLocation`	`UALocation.shared().isLocationUpdatesEnabled`

Airship Developer Guide:

iOS
Android

disableLocation

Disables location.

Remote Command	Airship Method
`disableLocation`	`UALocation.shared().isLocationUpdatesEnabled`

Airship Developer Guide:

iOS
Android

enableBackgroundLocation

Enables background location.

Remote Command	Airship Method
`enableBackgroundLocation`	`UALocation.shared().isBackgroundLocationUpdatesAllowed`

Airship Developer Guide:

iOS
Android

disableBackgroundLocation

Disables background location.

Remote Command	Airship Method
`disableBackgroundLocation`	`UALocation.shared().isBackgroundLocationUpdatesAllowed`

Airship Developer Guide:

iOS
Android