Class AirshipPush

constructor

• new AirshipPush(module): AirshipPush

• Parameters

  • module: any

  Returns AirshipPush

Readonly android

Readonly iOS

clearNotification

• clearNotification(identifier): void

• Clears a specific notification.

  On Android, you can use this method to clear notifications outside of Airship, The identifier is in the format of :.

  Parameters

  • identifier: string

    The identifier.

  Returns void

clearNotifications

• clearNotifications(): void

• Clears all notifications for the app.

  Returns void

enableUserNotifications

• enableUserNotifications(options?): Promise<boolean>

• Enables user notifications.

  Parameters

  • Optional options: {
        fallback?: SystemSettings;
    }

    Optional options.

    • Optional fallback?: SystemSettings

  Returns Promise<boolean>

  A promise with the permission result.

getActiveNotifications

• getActiveNotifications(): Promise<PushPayload[]>

• Gets the list of active notifications.

  On Android, this list only includes notifications sent through Airship.

  Returns Promise<PushPayload[]>

  A promise with the result.

getNotificationStatus

• getNotificationStatus(): Promise<PushNotificationStatus>

• Gets the notification status.

  Returns Promise<PushNotificationStatus>

  A promise with the result.

getRegistrationToken

• getRegistrationToken(): Promise<undefined | null | string>

• Gets the registration token if generated. Use the event EventType.PushTokenReceived to be notified when available.

  Returns Promise<undefined | null | string>

  A promise with the result.

isUserNotificationsEnabled

• isUserNotificationsEnabled(): Promise<boolean>

• Checks if user notifications are enabled or not on Airship.

  Returns Promise<boolean>

  A promise with the result.

setUserNotificationsEnabled

• setUserNotificationsEnabled(enabled): Promise<void>

• Enables/disables notifications on Airship.

  When enabled, it will cause the user to be prompted for the permission on platforms that support it. To get the result of the prompt, use enableUserNotifications.

  Parameters

  • enabled: boolean

    true to enable, false to disable

  Returns Promise<void>

  A promise.