Interface AirshipPush

Airship Push.

Hierarchy

AirshipPush

Index

Properties

Methods

clearNotification clearNotifications enableUserNotifications getActiveNotifications getNotificationStatus getPushToken isUserNotificationsEnabled onNotificationResponse onNotificationStatusChanged onPushReceived onPushTokenReceived setUserNotificationsEnabled

Properties

`Readonly` android

android: AirshipPushAndroid

Android only push methods.

`Readonly` ios

ios: AirshipPushIOS

iOS only push methods.

Methods

clearNotification

clearNotification(identifier: string, success?: (() => void), error?: ((err: string) => void)): 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.
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1069

clearNotifications

clearNotifications(success?: (() => void), error?: ((err: string) => void)): void
Clears all notifications for the app.
Parameters
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1054

enableUserNotifications

enableUserNotifications(success: ((enabled: boolean) => void), error?: ((err: string) => void)): void
Enables user notifications.
Parameters
- success: ((enabled: boolean) => void)
  
  Success callback.
  - - (enabled: boolean): void
    - Parameters
      
      enabled: boolean
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1000

getActiveNotifications

getActiveNotifications(success: ((payloads: PushPayload[]) => void), error?: ((err: string) => void)): void
Gets the list of active notifications.

On Android, this list only includes notifications sent through Airship.
Parameters
- success: ((payloads: PushPayload[]) => void)
  
  Success callback.
  - - (payloads: PushPayload[]): void
    - Parameters
      
      payloads: PushPayload[]
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1044

getNotificationStatus

getNotificationStatus(success: ((enabled: PushNotificationStatus) => void), error?: ((err: string) => void)): void
Gets the notification status.
Parameters
- success: ((enabled: PushNotificationStatus) => void)
  
  Success callback.
  - - (enabled: PushNotificationStatus): void
    - Parameters
      
      enabled: PushNotificationStatus
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1010

getPushToken

getPushToken(success: ((token: undefined | null | string) => void), error?: ((err: string) => void)): void
Gets the push token if generated. Use the event listener onPushTokenReceived to be notified when its available.
Parameters
- success: ((token: undefined | null | string) => void)
  
  Success callback.
  - - (token: undefined | null | string): void
    - Parameters
      
      token: undefined | null | string
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1031

isUserNotificationsEnabled

isUserNotificationsEnabled(success: ((enabled: boolean) => void), error?: ((err: string) => void)): void
Checks if user notifications are enabled or not on Airship.
Parameters
- success: ((enabled: boolean) => void)
  
  Success callback.
  - - (enabled: boolean): void
    - Parameters
      
      enabled: boolean
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:990

onNotificationResponse

onNotificationResponse(callback: ((event: NotificationResponseEvent) => void)): Cancellable
Notification response listener.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: NotificationResponseEvent) => void)
  
  The callback.
  - - (event: NotificationResponseEvent): void
    - Parameters
      
      event: NotificationResponseEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1091

onNotificationStatusChanged

onNotificationStatusChanged(callback: ((event: PushNotificationStatusChangedEvent) => void)): Cancellable
Event when the notification status has changed.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: PushNotificationStatusChangedEvent) => void)
  
  The callback.
  - - (event: PushNotificationStatusChangedEvent): void
    - Parameters
      
      event: PushNotificationStatusChangedEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1021

onPushReceived

onPushReceived(callback: ((event: PushReceivedEvent) => void)): Cancellable
Push received listener.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: PushReceivedEvent) => void)
  
  The callback.
  - - (event: PushReceivedEvent): void
    - Parameters
      
      event: PushReceivedEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1081

onPushTokenReceived

onPushTokenReceived(callback: ((event: PushTokenReceivedEvent) => void)): Cancellable
Push token listener.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: PushTokenReceivedEvent) => void)
  
  The callback.
  - - (event: PushTokenReceivedEvent): void
    - Parameters
      
      event: PushTokenReceivedEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1101

setUserNotificationsEnabled

setUserNotificationsEnabled(enabled: boolean, success?: (() => void), error?: ((err: string) => void)): 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
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:979

Interface AirshipPush

Hierarchy

Index

Properties

Methods

Properties

Readonly android

Readonly ios

Methods

clearNotification

Parameters

identifier: string

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

clearNotifications

Parameters

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

enableUserNotifications

Parameters

success: ((enabled: boolean) => void)

Parameters

enabled: boolean

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getActiveNotifications

Parameters

success: ((payloads: PushPayload[]) => void)

Parameters

payloads: PushPayload[]

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getNotificationStatus

Parameters

success: ((enabled: PushNotificationStatus) => void)

Parameters

enabled: PushNotificationStatus

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getPushToken

Parameters

success: ((token: undefined | null | string) => void)

Parameters

token: undefined | null | string

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

isUserNotificationsEnabled

Parameters

success: ((enabled: boolean) => void)

Parameters

enabled: boolean

Returns void

Optional error: ((err: string) => void)

Parameters

`Readonly` android

`Readonly` ios

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)