Airship.Net
AirshipDotNet.Airship Class Reference

Provides cross-platform access to a common subset of functionality between the iOS and Android SDKs. More...

Inherits Java.Lang.Object, IDeepLinkListener, UrbanAirship.Channel.IAirshipChannelListener, IPushNotificationStatusListener, UrbanAirship.MessageCenter.IInboxListener, IPushTokenListener, IPushListener, INotificationListener, and NSObject.

Public Member Functions

 Airship ()
bool OnDeepLink (string deepLink)
void OnChannelCreated (string channelId)
void OnChange (UrbanAirship.Push.PushNotificationStatus status)
void OnInboxUpdated ()
void OnPushTokenUpdated (string token)
void OnNotificationPosted (NotificationInfo notificationInfo)
bool OnNotificationOpened (NotificationInfo notificationInfo)
bool OnNotificationForegroundAction (NotificationInfo notificationInfo, NotificationActionButtonInfo actionButtonInfo)
void OnNotificationBackgroundAction (NotificationInfo notificationInfo, NotificationActionButtonInfo actionButtonInfo)
void OnNotificationDismissed (NotificationInfo notificationInfo)
 Airship ()

Static Public Member Functions

static Task< bool > ProcessDeepLink (string url)
 Processes a deep link.
static Task< bool > ProcessDeepLink (string url)
 Processes a deep link.

Properties

static Airship Instance [get]
static string Version [get]
 Gets the Airship .NET library version.
static IAirshipPush Push [get]
static IAirshipChannel Channel [get]
static IAirshipContact Contact [get]
static IAirshipAnalytics Analytics [get]
static IAirshipInApp InApp [get]
static IAirshipPrivacyManager PrivacyManager [get]
static IAirshipFeatureFlagManager FeatureFlagManager [get]
static IAirshipPreferenceCenter PreferenceCenter [get]
static IAirshipMessageCenter MessageCenter [get]
static IAirshipPermissionsManager PermissionsManager [get]

Events

EventHandler< ChannelEventArgs >? OnChannelCreation [add, remove]
 Add/remove the channel creation listener.
EventHandler< PushNotificationStatusEventArgs >? OnPushNotificationStatusUpdate [add, remove]
 Add/remove the push notification status listener.
EventHandler< DeepLinkEventArgsOnDeepLinkReceived [add, remove]
 Add/remove the deep link listener.
EventHandler< PushReceivedEventArgs >? OnPushReceived [add, remove]
 Add/remove the push received listener.
EventHandler< NotificationResponseEventArgs >? OnNotificationResponse [add, remove]
 Add/remove the notification response listener (user tap or action button).
EventHandler< PushTokenReceivedEventArgs >? OnPushTokenReceived [add, remove]
 Add/remove the push token received listener.
EventHandler< MessageCenterEventArgs >? OnDisplayMessageCenter [add, remove]
 Add/remove the message center display request listener.
EventHandler< EventArgs >? OnMessageCenterUpdated [add, remove]
 Add/remove the message center inbox updated listener.
EventHandler< PreferenceCenterEventArgs >? OnDisplayPreferenceCenter [add, remove]
 Add/remove the preference center display request listener.
EventHandler< IOSAuthorizedNotificationSettingsEventArgs >? OnAuthorizedNotificationSettingsChanged [add, remove]
 Add/remove the iOS authorized notification settings change listener.

Detailed Description

Provides cross-platform access to a common subset of functionality between the iOS and Android SDKs.

Constructor & Destructor Documentation

◆ Airship() [1/2]

AirshipDotNet.Airship.Airship ( )
inline

◆ Airship() [2/2]

AirshipDotNet.Airship.Airship ( )
inline

Member Function Documentation

◆ OnChange()

void AirshipDotNet.Airship.OnChange ( UrbanAirship.Push.PushNotificationStatus status)
inline

◆ OnChannelCreated()

void AirshipDotNet.Airship.OnChannelCreated ( string channelId)
inline

◆ OnDeepLink()

bool AirshipDotNet.Airship.OnDeepLink ( string deepLink)
inline

◆ OnInboxUpdated()

void AirshipDotNet.Airship.OnInboxUpdated ( )
inline

◆ OnNotificationBackgroundAction()

void AirshipDotNet.Airship.OnNotificationBackgroundAction ( NotificationInfo notificationInfo,
NotificationActionButtonInfo actionButtonInfo )
inline

◆ OnNotificationDismissed()

void AirshipDotNet.Airship.OnNotificationDismissed ( NotificationInfo notificationInfo)
inline

◆ OnNotificationForegroundAction()

bool AirshipDotNet.Airship.OnNotificationForegroundAction ( NotificationInfo notificationInfo,
NotificationActionButtonInfo actionButtonInfo )
inline

◆ OnNotificationOpened()

bool AirshipDotNet.Airship.OnNotificationOpened ( NotificationInfo notificationInfo)
inline

◆ OnNotificationPosted()

void AirshipDotNet.Airship.OnNotificationPosted ( NotificationInfo notificationInfo)
inline

◆ OnPushTokenUpdated()

void AirshipDotNet.Airship.OnPushTokenUpdated ( string token)
inline

◆ ProcessDeepLink() [1/2]

Task< bool > AirshipDotNet.Airship.ProcessDeepLink ( string url)
inlinestatic

Processes a deep link.

For uairship:// scheme URLs, Airship will handle the deep link internally. For other URLs, Airship will forward the deep link to the deep link listener if set.

Parameters
urlThe deep link URL.
Returns
True if the deep link was handled, false otherwise.

◆ ProcessDeepLink() [2/2]

Task< bool > AirshipDotNet.Airship.ProcessDeepLink ( string url)
inlinestatic

Processes a deep link.

Parameters
urlThe deep link URL.
Returns
A task that completes with true if the deep link was handled, false otherwise.

Property Documentation

◆ Analytics

IAirshipAnalytics AirshipDotNet.Airship.Analytics
staticget

◆ Channel

IAirshipChannel AirshipDotNet.Airship.Channel
staticget

◆ Contact

IAirshipContact AirshipDotNet.Airship.Contact
staticget

◆ FeatureFlagManager

IAirshipFeatureFlagManager AirshipDotNet.Airship.FeatureFlagManager
staticget

◆ InApp

IAirshipInApp AirshipDotNet.Airship.InApp
staticget

◆ Instance

Airship AirshipDotNet.Airship.Instance
staticget

◆ MessageCenter

IAirshipMessageCenter AirshipDotNet.Airship.MessageCenter
staticget

◆ PermissionsManager

IAirshipPermissionsManager AirshipDotNet.Airship.PermissionsManager
staticget

◆ PreferenceCenter

IAirshipPreferenceCenter AirshipDotNet.Airship.PreferenceCenter
staticget

◆ PrivacyManager

IAirshipPrivacyManager AirshipDotNet.Airship.PrivacyManager
staticget

◆ Push

IAirshipPush AirshipDotNet.Airship.Push
staticget

◆ Version

string AirshipDotNet.Airship.Version
staticget

Gets the Airship .NET library version.

Event Documentation

◆ OnAuthorizedNotificationSettingsChanged

EventHandler<IOSAuthorizedNotificationSettingsEventArgs>? AirshipDotNet.Airship.OnAuthorizedNotificationSettingsChanged
addremove

Add/remove the iOS authorized notification settings change listener.

◆ OnChannelCreation

EventHandler< ChannelEventArgs > AirshipDotNet.Airship.OnChannelCreation
addremove

Add/remove the channel creation listener.

◆ OnDeepLinkReceived

EventHandler< DeepLinkEventArgs > AirshipDotNet.Airship.OnDeepLinkReceived
addremove

Add/remove the deep link listener.

◆ OnDisplayMessageCenter

EventHandler< MessageCenterEventArgs > AirshipDotNet.Airship.OnDisplayMessageCenter
addremove

Add/remove the message center display request listener.

◆ OnDisplayPreferenceCenter

EventHandler< PreferenceCenterEventArgs > AirshipDotNet.Airship.OnDisplayPreferenceCenter
addremove

Add/remove the preference center display request listener.

◆ OnMessageCenterUpdated

EventHandler< EventArgs > AirshipDotNet.Airship.OnMessageCenterUpdated
addremove

Add/remove the message center inbox updated listener.

◆ OnNotificationResponse

EventHandler< NotificationResponseEventArgs > AirshipDotNet.Airship.OnNotificationResponse
addremove

Add/remove the notification response listener (user tap or action button).

◆ OnPushNotificationStatusUpdate

EventHandler< PushNotificationStatusEventArgs > AirshipDotNet.Airship.OnPushNotificationStatusUpdate
addremove

Add/remove the push notification status listener.

◆ OnPushReceived

EventHandler< PushReceivedEventArgs > AirshipDotNet.Airship.OnPushReceived
addremove

Add/remove the push received listener.

Fires for both foreground and background pushes.

◆ OnPushTokenReceived

EventHandler< PushTokenReceivedEventArgs > AirshipDotNet.Airship.OnPushTokenReceived
addremove

Add/remove the push token received listener.