Class AirshipPushAndroid

Android Push.

Index

Constructors

Properties

eventEmitter foregroundDisplayPredicate? module

Methods

isNotificationChannelEnabled setForegroundDisplayPredicate setNotificationConfig

Constructors

constructor

new AirshipPushAndroid(module): AirshipPushAndroid
Parameters
- module: any
Returns AirshipPushAndroid
- Defined in src/AirshipPush.ts:226

Properties

`Private` eventEmitter

eventEmitter: NativeEventEmitter

`Private` `Optional` foregroundDisplayPredicate

foregroundDisplayPredicate?: ((pushPayload) => Promise<boolean>)

Type declaration

- (pushPayload): Promise<boolean>
- Parameters
  - pushPayload: PushPayload
  Returns Promise<boolean>

`Private` `Readonly` module

module: any

Methods

isNotificationChannelEnabled

isNotificationChannelEnabled(channel): Promise<boolean>
Checks if a notification category/channel is enabled.
Parameters
- channel: string
  The channel name.
Returns Promise<boolean>
A promise with the result.
- Defined in src/AirshipPush.ts:250

setForegroundDisplayPredicate

setForegroundDisplayPredicate(predicate?): void
Overrides the foreground display per notification.

The predicate should return as quickly as possible to avoid delaying notification delivery.
Parameters
- Optional predicate: ((pushPayload) => Promise<boolean>)
  A foreground display predicate.
  - - (pushPayload): Promise<boolean>
    - Parameters
      pushPayload: PushPayload
      Returns Promise<boolean>
Returns void
- Defined in src/AirshipPush.ts:269

setNotificationConfig

setNotificationConfig(config): void
Sets the notification config.
Parameters
- config: NotificationConfig
  The notification config.
Returns void
- Defined in src/AirshipPush.ts:258