Notification Events

The Airship SDK provides events for when a push is received or a notification is interacted with. Apps can use these events for custom push processing. Registering for an event is optional; the SDK will automatically launch the application without the need to set one.

Notification Events

Push Received

Listen for when a push notification is received. This event fires whether the app is in the foreground or background.

Airship.Shared.OnPushReceived += (PushMessage message) => {
    // Handle push received event
};

Push Opened

Listen for when a user taps a notification.

Airship.Shared.OnPushOpened += (PushMessage message) => {
    // Handle notification open
};

Registration Token Updates

Listen for when the push registration token is generated or updated.

Airship.Shared.OnPushTokenReceived += (string pushToken) => {
    // Send the token to your backend if needed
};

You can also retrieve the current token at any time.

string token = Airship.Shared.push.GetPushToken();

Notification Status Changes

Monitor changes to the notification permission status.

Airship.Shared.OnNotificationStatusChanged += (PushNotificationStatus status) => {
    Debug.Log("Is opted in: " + status.isOptedIn);
};

Managing Active Notifications

You can retrieve and clear notifications that are currently displayed in the notification center.

Get Active Notifications

Retrieve the list of currently displayed notifications. GetActiveNotifications is asynchronous, so run it as a coroutine.

StartCoroutine(Airship.Shared.push.GetActiveNotifications((IEnumerable<PushMessage> notifications) => {
    // Handle active notifications
}));

Clear Notifications

Clear all notifications for the app:

Airship.Shared.push.ClearNotifications();

Clear a specific notification by identifier:

Airship.Shared.push.ClearNotification(identifier);

Silent Notifications

Silent notifications are push messages that do not present a notification to the user. These are typically used to briefly wake the app from a background state to perform processing tasks or fetch remote content.

Platform Configuration

For iOS, set the content_available property to true in the iOS override object.

For Android, all push messages are delivered in the background, and by default Airship will treat messages without an alert as silent.

Handling Silent Notifications

Silent notifications trigger the OnPushReceived event but do not display a notification to the user.

Airship.Shared.OnPushReceived += (PushMessage message) => {
    if (string.IsNullOrEmpty(message.Alert))
    {
        // Perform background work
    }
};