Help

1 min read

Airship

Last Updated - Platform 25.0 - SDK 20.0

The PoqAirship integration wraps the Airship SDK allowing it to be plugged into the PoqSDK to enable remote notifications driven by Airship. This also includes the Airship Inbox and Preference Center, which work with the Account badges, and are styled to match the rest of the app.

Set up

https://github.com/poqcommerce/Poq.iOS.Airship.git

  1. Make sure the app is set up in the Airship dashboard.
  2. Add the PoqAirship framework from the URL above to your project. How?
  3. Register the integration in your AppDelegate.swift.
import PoqAirship


class AppDelegate: BaseAppDelegate {
    override func setupModules() {
        PoqPlatform.shared.addModule(PoqAirship())
    }
}
  1. Ensure you add an AirshipConfig.plist from your Airship account to the app.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>developmentAppKey</key>
    <string></string>
    <key>developmentAppSecret</key>
    <string></string>
    <key>productionAppKey</key>
    <string></string>
    <key>productionAppSecret</key>
    <string></string>
</dict>
</plist>

Notifications

Airship can be set up as a single 'Live' project or with an additional 'Test' project. When the app is being run via Xcode it will connect to the 'Test' project. When the app is archived for any type of distribution, Xcode switches the app to connect to the 'Live' project.

A developer will need to make sure the Airship projects are set up with your Apple Account APNs Key. Use the existing key; there should only be 1 APNs key that should be shared by all apps in that account.

Developer Mode

Airship switches to use the AirshipConfig-Development.plist config when in development mode, if it exists. If this config does not exist then Airship uses the live config instead (in developer mode). Whilst it's less of an issue for Airship, this does means that any fake purchase revenue from development environments will be sent to Airship as if it was live revenue.

Environment

On iOS an Environment:{id} tag is added to segment the audience by 'AppConfig' where {id} is replaced with the config identifier.

History

  • 12.0 (Oct 23): Release for Poq SDK 20 (v25).
  • 11.1 (Sep 23): Added AirshipConfig-Development safeguard for developer mode.
  • 11.0 (Mar 23): Release for Poq SDK 19 (v24) adopting the new analytics layer.
  • 10.2 (Sep 23): Added AirshipConfig-Development safeguard for developer mode.
  • 10.1 (Jan 23): Added Airship Automation to fix In-App messages.
  • 10.0 (Nov 22): Release for Poq SDK 18 (v23) with environment tagging for the App Switcher.
  • Releases...