Class AirshipPush

Airship Push.

Hierarchy

AirshipPush

Index

Constructors

constructor

new AirshipPush(plugin: AirshipPluginWrapper): AirshipPush
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipPush
- Defined in AirshipPush.ts:30

Properties

`Readonly` android

android: AirshipPushAndroid

Android only push methods.

`Readonly` iOS

iOS: AirshipPushIOS

iOS only push methods.

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

clearNotification

clearNotification(identifier: string): Promise<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 :.

Returns
A promise with the result.
Parameters
- identifier: string
  
  The identifier.
Returns Promise<void>
- Defined in AirshipPush.ts:110

clearNotifications

clearNotifications(): Promise<void>
Clears all notifications for the app.

Returns
A promise with the result.

Returns Promise<void>
- Defined in AirshipPush.ts:97

enableUserNotifications

enableUserNotifications(): Promise<boolean>
Enables user notifications.

Returns
A promise with the permission result.

Returns Promise<boolean>
- Defined in AirshipPush.ts:60

getActiveNotifications

getActiveNotifications(): Promise<PushPayload[]>
Gets the list of active notifications.

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

Returns
A promise with the result.

Returns Promise<PushPayload[]>
- Defined in AirshipPush.ts:89

getNotificationStatus

getNotificationStatus(): Promise<PushNotificationStatus>
Gets the notification status.

Returns
A promise with the result.

Returns Promise<PushNotificationStatus>
- Defined in AirshipPush.ts:68

getPushToken

getPushToken(): Promise<undefined | null | string>
Gets the registration token if generated. Use the event EventType.PushTokenReceived to be notified when available.

Returns
A promise with the result.

Returns Promise<undefined | null | string>
- Defined in AirshipPush.ts:78

isUserNotificationsEnabled

isUserNotificationsEnabled(): Promise<boolean>
Checks if user notifications are enabled or not on Airship.

Returns
A promise with the result.

Returns Promise<boolean>
- Defined in AirshipPush.ts:52

onNotificationResponse

onNotificationResponse(listener: ((event: NotificationResponseEvent) => void)): Promise<PluginListenerHandle>
Adds a notification response event listener.
Parameters
- listener: ((event: NotificationResponseEvent) => void)
  - - (event: NotificationResponseEvent): void
    - Parameters
      
      event: NotificationResponseEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPush.ts:117

onNotificationStatusChanged

onNotificationStatusChanged(listener: ((event: PushNotificationStatusChangedEvent) => void)): Promise<PluginListenerHandle>
Adds a notification status changed event listener.
Parameters
- listener: ((event: PushNotificationStatusChangedEvent) => void)
  - - (event: PushNotificationStatusChangedEvent): void
    - Parameters
      
      event: PushNotificationStatusChangedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPush.ts:135

onPushReceived

onPushReceived(listener: ((event: PushReceivedEvent) => void)): Promise<PluginListenerHandle>
Adds a push received event listener.
Parameters
- listener: ((event: PushReceivedEvent) => void)
  - - (event: PushReceivedEvent): void
    - Parameters
      
      event: PushReceivedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPush.ts:126

onPushTokenReceived

onPushTokenReceived(listener: ((event: PushTokenReceivedEvent) => void)): Promise<PluginListenerHandle>
Adds a notification status changed event listener.
Parameters
- listener: ((event: PushTokenReceivedEvent) => void)
  - - (event: PushTokenReceivedEvent): void
    - Parameters
      
      event: PushTokenReceivedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPush.ts:144

setUserNotificationsEnabled

setUserNotificationsEnabled(enabled: boolean): 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.

Returns
A promise.
Parameters
- enabled: boolean
  
  true to enable, false to disable
Returns Promise<void>
- Defined in AirshipPush.ts:44

Class AirshipPush

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

plugin: AirshipPluginWrapper

Returns AirshipPush

Properties

Readonly android

Readonly iOS

Private Readonly plugin

Methods

clearNotification

Returns

Parameters

identifier: string

Returns Promise<void>

clearNotifications

Returns

Returns Promise<void>

enableUserNotifications

Returns

Returns Promise<boolean>

getActiveNotifications

Returns

Returns Promise<PushPayload[]>

getNotificationStatus

Returns

Returns Promise<PushNotificationStatus>

getPushToken

Returns

Returns Promise<undefined | null | string>

isUserNotificationsEnabled

Returns

Returns Promise<boolean>

onNotificationResponse

Parameters

listener: ((event: NotificationResponseEvent) => void)

Parameters

event: NotificationResponseEvent

Returns void

Returns Promise<PluginListenerHandle>

onNotificationStatusChanged

Parameters

listener: ((event: PushNotificationStatusChangedEvent) => void)

Parameters

event: PushNotificationStatusChangedEvent

Returns void

Returns Promise<PluginListenerHandle>

onPushReceived

Parameters

listener: ((event: PushReceivedEvent) => void)

Parameters

event: PushReceivedEvent

Returns void

Returns Promise<PluginListenerHandle>

onPushTokenReceived

Parameters

listener: ((event: PushTokenReceivedEvent) => void)

Parameters

event: PushTokenReceivedEvent

Returns void

Returns Promise<PluginListenerHandle>

setUserNotificationsEnabled

Returns

Parameters

enabled: boolean

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` android

`Readonly` iOS

`Private` `Readonly` plugin