This version of the plugin now requires iOS 14+ as the min deployment target and Xcode 14.3+.
The API is now divided up into functional components that can be accessed from the Airship instance. Use the table
for replacements.
| 6.x | 7.x |
|---|---|
| Airship.takeOff(String appKey, String appSecret) : Future | Airship.takeOff(AirshipConfig config) : Future |
| Airship.channelId : Future | Airship.channel.identifier : Future |
| Airship.editChannelSubscriptionLists() : SubscriptionListEditor | Airship.channel.editSubscriptionLists() : SubscriptionListEditor |
| Airship.onChannelRegistration : Stream | Airship.channel.onChannelCreated : Stream |
| Airship.getSubscriptionLists(List subscriptionListTypes) : Future (if types are "channel") | Airship.channel.subscriptionLists : Future<List> |
| Airship.addTags(List tags) : Future | Airship.channel.addTags(List tags) : Future |
| Airship.removeTags(List tags) : Future | Airship.channel.removeTags(List tags) : Future |
| Airship.tags : Future<List> | Airship.channel.tags : Future<List> |
| Airship.enableChannelCreation() : Future | Airship.channel.enableChannelCreation() : Future |
| Airship.editAttributes() : AttributeEditor | Airship.channel.editAttributes() : AttributeEditor |
| Airship.editChannelTagGroups() : TagGroupEditor | Airship.channel.editTagGroups() : TagGroupEditor |
| Airship.userNotificationsEnabled : Future<bool?> | Airship.push.isUserNotificationsEnabled : Future |
| Airship.setUserNotificationsEnabled : Future<bool?> | Airship.push.setUserNotificationsEnabled : Future |
| Airship.activeNotifications : Future<List> | Airship.push.activeNotifications : Future<List> |
| Airship.clearNotification(String notification) : Future | Airship.push.clearNotification(String notification) : Future |
| Airship.clearNotifications() : Future | Airship.push.clearNotifications() : Future |
| Airship.onPushReceived : Stream | Airship.push.onPushReceived : Stream |
| Airship.onNotificationResponse : Stream | Airship.push.onNotificationResponse : Stream |
| Airship.setBackgroundMessageHandler(BackgroundMessageHandler handler) : Future | Airship.push.android.setBackgroundPushReceivedHandler(AndroidBackgroundPushReceivedHandler handler) : Future |
| Airship.isAutoBadgeEnabled() : Future | Airship.push.iOS.isAutoBadgeEnabled() : Future |
| Airship.setAutoBadgeEnabled(bool enabled) : Future | Airship.push.iOS.setAutoBadgeEnabled(bool enabled) : Future |
| Airship.setBadge(int badge) : Future | Airship.push.iOS.setBadge(int badge) : Future |
| Airship.resetBadge() : Future | Airship.push.iOS.resetBadge() : Future |
| Airship.getSubscriptionLists(List subscriptionListTypes) : Future (if types are "contact") | Airship.contact.subscriptionLists : Future<Map<String, List>> |
| Airship.namedUser : Future<String?> | Airship.contact.namedUserId : Future<String?> |
| Airship.setNamedUser(String? namedUser) : Future | Airship.contact.identify(String namedUser) : Future |
| Airship.editContactSubscriptionLists() : ScopedSubscriptionListEditor | Airship.contact.editSubscriptionLists() : ScopedSubscriptionListEditor |
| Airship.editNamedUserTagGroups() : TagGroupEditor | Airship.contact.editTagGroups() : TagGroupEditor |
| Airship.setInAppAutomationPaused(bool paused) : Future | Airship.inApp.setPaused(bool paused) : Future |
| Airship.getInAppAutomationPaused : Future | Airship.inApp.isPaused : Future |
| Airship.inboxMessages : Future<List> | Airship.messageCenter.messages : Future<List> |
| Airship.markInboxMessageRead(InboxMessage message) : Future | Airship.messageCenter.markRead(String messageId) : Future |
| Airship.deleteInboxMessage(InboxMessage message) : Future | Airship.messageCenter.deleteMessage(String messageId) : Future |
| Airship.refreshInbox() : Future<bool?> | Airship.messageCenter.refreshInbox() : Future<bool?> |
| Airship.onInboxUpdated : Stream? | Airship.messageCenter.onInboxUpdated : Stream |
| Airship.onShowInbox : Stream? | Airship.messageCenter.onDisplay : Stream |
| Airship.enableFeatures(List features) : Future | Airship.privacyManager.enableFeatures(List features) : Future |
| Airship.disableFeatures(List features) : Future | Airship.privacyManager.disableFeatures(List features) : Future |
| Airship.setEnabledFeatures(List features) : Future | Airship.privacyManager.setEnabledFeatures(List features) : Future |
| Airship.getEnabledFeatures() : Future<List> | Airship.privacyManager.enabledFeatures : Future<List> |
| Airship.isFeatureEnabled(String feature) : Future | Airship.privacyManager.isFeaturesEnabled(List features) : Future |
| Airship.getPreferenceCenterConfig(String preferenceCenterID) : Future<PreferenceCenterConfig?> | Airship.preferenceCenter.getConfig(String preferenceCenterID) : Future<PreferenceCenterConfig?> |
| Airship.setAutoLaunchDefaultPreferenceCenter(bool enabled) : Future | Airship.preferenceCenter.setAutoLaunchDefaultPreferenceCenter(String preferenceCenterID, bool autoLaunch) : Future |
| Airship.openPreferenceCenter(String preferenceCenterID) : Future | Airship.preferenceCenter.display(String preferenceCenterID) : Future |
| Airship.onShowPreferenceCenter : Stream<String?> | Airship.preferenceCenter.onDisplay : Stream |
| Airship.trackScreen(String screen) : Future | Airship.analytics.trackScreen(String screen) : Future |
| Airship.addEvent(CustomEvent event) : Future | Airship.analytics.addEvent(CustomEvent event) : Future |
Airship.onShowInbox and Airship.onShowInboxMessage have been merged into a single Stream Airship.messageCenter.onDisplay. The even will now contain a property with an optional messageId if the a particular message should be displayed.
In 7.0.0, the default Message Center will display unless disabled with Airship.messageCenter.setAutoLaunchDefaultMessageCenter(false);. Display events will not be emitted if the default message center UI is enabled.
Disabling auto launching the default preference center UI from past versions will not carry forward to plugin 7.0.0. Instead, you will now have to disable the default preference center UI per preference center ID.