Capacitor Airship Plugin

The official Airship Capacitor plugin for iOS and Android.

Features

• Push Notifications - Rich, interactive push notifications with deep linking
• Live Activities & Live Updates - Real-time content updates on iOS Lock Screen and Android Live Content
• In-App Experiences - Contextual messaging, automation, and Scenes
• Message Center - Persistent inbox for rich messages with HTML, video, and interactive content
• Preference Center - User preference management
• Feature Flags - Dynamic feature toggles and experimentation
• Analytics - Comprehensive user behavior tracking
• Contacts - User identification and contact management
• Tags, Attributes & Subscription Lists - User segmentation, personalization, and subscription management
• Privacy Controls - Granular data collection and feature management

Quick Start

Install the package:

npm install @ua/capacitor-airship
npx cap sync

Initialization

Call takeOff once during app startup, before any other Airship API:

import { Airship } from '@ua/capacitor-airship';

await Airship.takeOff({
  default: {
    appKey: 'YOUR_APP_KEY',
    appSecret: 'YOUR_APP_SECRET',
  },
});

await Airship.push.enableUserNotifications();

For a more detailed setup guide, please see the full Getting Started Documentation.

Versions and Support

For the current Support Status of each plugin major, EOL dates, and the full lifecycle policy, see the Airship SDK Support Policy.

Resources

• Documentation - Complete SDK integration guides and feature documentation
• API Reference - Detailed TypeScript API documentation
• SDK Support Policy - Version lifecycle, support windows, and EOL dates across all Airship SDKs
• GitHub Issues - Report bugs and request features
• Changelog - Release notes and version history
• Support - Contact Airship support