|
1 | 1 | # Cordova Airship Plugin |
2 | 2 |
|
3 | | -A Cordova plugin for Airship's iOS and Android SDK. |
| 3 | +[](https://badge.fury.io/js/%40ua%2Fcordova-airship) |
| 4 | +[](https://opensource.org/licenses/Apache-2.0) |
4 | 5 |
|
5 | | -### Resources |
| 6 | +The official Airship Cordova plugin for iOS and Android. |
6 | 7 |
|
7 | | -* [Getting started guide](https://docs.airship.com/platform/mobile/setup/sdk/cordova/) |
8 | | -* [API docs](https://docs.airship.com/reference/libraries/urbanairship-cordova/latest/) |
| 8 | +> **Using Capacitor?** See the [capacitor-airship](https://github.com/urbanairship/capacitor-airship) plugin instead. |
9 | 9 |
|
10 | | -### Issues |
| 10 | +## Features |
11 | 11 |
|
12 | | -Please visit https://support.airship.com/ for any issues integrating or using this plugin. |
| 12 | +- **Push Notifications** - Rich, interactive push notifications with deep linking |
| 13 | +- **Live Activities & Live Updates** - Real-time content updates on iOS Lock Screen and Android Live Content |
| 14 | +- **In-App Experiences** - Contextual messaging, automation, and Scenes |
| 15 | +- **Message Center** - Persistent inbox for rich messages with HTML, video, and interactive content |
| 16 | +- **Preference Center** - User preference management |
| 17 | +- **Feature Flags** - Dynamic feature toggles and experimentation |
| 18 | +- **Analytics** - Comprehensive user behavior tracking |
| 19 | +- **Contacts** - User identification and contact management |
| 20 | +- **Tags, Attributes & Subscription Lists** - User segmentation, personalization, and subscription management |
| 21 | +- **Privacy Controls** - Granular data collection and feature management |
| 22 | + |
| 23 | +## Quick Start |
| 24 | + |
| 25 | +Install the plugin: |
| 26 | +```bash |
| 27 | +cordova plugin add @ua/cordova-airship |
| 28 | +``` |
| 29 | + |
| 30 | +### Initialization |
| 31 | + |
| 32 | +Call `takeOff` once during app startup, before any other Airship API: |
| 33 | +```javascript |
| 34 | +document.addEventListener('deviceready', function () { |
| 35 | + Airship.takeOff({ |
| 36 | + default: { |
| 37 | + appKey: 'YOUR_APP_KEY', |
| 38 | + appSecret: 'YOUR_APP_SECRET', |
| 39 | + }, |
| 40 | + }, function () { |
| 41 | + Airship.push.enableUserNotifications(); |
| 42 | + }); |
| 43 | +}); |
| 44 | +``` |
| 45 | + |
| 46 | +For a more detailed setup guide, please see the full [Getting Started Documentation](https://docs.airship.com/platform/mobile/setup/sdk/cordova/). |
| 47 | + |
| 48 | +## Versions and Support |
| 49 | + |
| 50 | +For the current Support Status of each plugin major, EOL dates, and the full lifecycle policy, see the [Airship SDK Support Policy](https://www.airship.com/docs/reference/sdk-support-policy/). |
| 51 | + |
| 52 | +## Resources |
| 53 | + |
| 54 | +- **[Documentation](https://docs.airship.com/platform/mobile/setup/sdk/cordova/)** - Complete SDK integration guides and feature documentation |
| 55 | +- **[API Reference](https://docs.airship.com/reference/libraries/urbanairship-cordova/latest/)** - Detailed TypeScript API documentation |
| 56 | +- **[SDK Support Policy](https://www.airship.com/docs/reference/sdk-support-policy/)** - Version lifecycle, support windows, and EOL dates across all Airship SDKs |
| 57 | +- **[GitHub Issues](https://github.com/urbanairship/urbanairship-cordova/issues)** - Report bugs and request features |
| 58 | +- **[Changelog](CHANGELOG.md)** - Release notes and version history |
| 59 | +- **[Support](https://support.airship.com/)** - Contact Airship support |
0 commit comments