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. Android 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 channelCaptureEnabled flag in your app’s airshipconfig.properties. This tool is enabled by default.

airshipconfig.properties
channelCaptureEnabled = true
AirshipConfigOptions
AirshipConfigOptions options = AirshipConfigOptions.newBuilder()
        ...
        .setChannelCaptureEnabled(true)
        .build();
val options = AirshipConfigOptions.newBuilder()
        ...
        .setChannelCaptureEnabled(true)
        .build()

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.

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