Channel Capture Tool

A tool to expose the Channel ID to the user.

The Channel ID is valuable for troubleshooting individual device issues in production apps. iOS SDKs since 6.1.0 include a Channel Capture tool that can be used to expose the Channel ID to the user, who can then send it to support. App developers are asked to enable the Channel Capture tool or to provide another mechanism to get the user’s Channel ID.

The Channel Capture tool can be enabled or disabled using the Config channelCaptureEnabled flag in your app’s AirshipConfig.plist. This tool is enabled by default.

AirshipConfig.plist
<?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>channelCaptureEnabled</key>
  <true/>
  ...
</dict>
</plist>

The Channel Capture tool can be programatically enabled or disabled. This enable state no longer persists through app init, and will instead revert to the value of the channelCaptureEnabled key in AirshipConfig.plist.

Config
config.isChannelCaptureEnabled = true
config.isChannelCaptureEnabled = YES;

If the Channel Capture tool is active, it listens for 6 app foregrounds within 30 seconds. On the 6th open, the Channel ID will be copied to the user’s clipboard a leading ua:. Paste your Channel ID from the clipboard to your preferred document. If there is no channel, only the ua: will be present. The channel will remain on the clipboard for 60 seconds.

Example Channel ID copied to clipboard
ua:9c80a583-eaf6-4af3-97dc-361474ef03bb