Class AirshipPushIOS

iOS Push.

Index

Constructors

Properties

eventEmitter module presentationOverridesCallback?

Methods

getAuthorizedNotificationSettings getAuthorizedNotificationStatus getBadgeNumber isAutobadgeEnabled setAutobadgeEnabled setBadgeNumber setForegroundPresentationOptions setForegroundPresentationOptionsCallback setNotificationOptions

Constructors

constructor

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

Properties

`Private` eventEmitter

eventEmitter: NativeEventEmitter

`Private` `Readonly` module

module: any

`Private` `Optional` presentationOverridesCallback

presentationOverridesCallback?: ((pushPayload) => Promise<null | ForegroundPresentationOption[]>)

Type declaration

- (pushPayload): Promise<null | ForegroundPresentationOption[]>
- Parameters
  - pushPayload: PushPayload
  Returns Promise<null | ForegroundPresentationOption[]>

Methods

getAuthorizedNotificationSettings

getAuthorizedNotificationSettings(): Promise<AuthorizedNotificationSetting[]>
Gets the list of authorized notification settings.

Returns Promise<AuthorizedNotificationSetting[]>
A promise with the result.
- Defined in src/AirshipPush.ts:205

getAuthorizedNotificationStatus

getAuthorizedNotificationStatus(): Promise<AuthorizedNotificationStatus>
Gets the authorized notification status.

Returns Promise<AuthorizedNotificationStatus>
A promise with the result.
- Defined in src/AirshipPush.ts:213

getBadgeNumber

getBadgeNumber(): Promise<number>
Gets the badge number.

Returns Promise<number>
A promise with the result.
- Defined in src/AirshipPush.ts:197

isAutobadgeEnabled

isAutobadgeEnabled(): Promise<boolean>
Checks if autobadge is enabled.

Returns Promise<boolean>
A promise with the result.
- Defined in src/AirshipPush.ts:171

setAutobadgeEnabled

setAutobadgeEnabled(enabled): Promise<void>
Enables/disables autobadge.
Parameters
- enabled: boolean
  true to enable, false to disable.
Returns Promise<void>
A promise.
- Defined in src/AirshipPush.ts:180

setBadgeNumber

setBadgeNumber(badge): Promise<void>
Set the badge number.
Parameters
- badge: number
  The badge number.
Returns Promise<void>
A promise.
- Defined in src/AirshipPush.ts:189

setForegroundPresentationOptions

setForegroundPresentationOptions(options): Promise<void>
Sets the foreground presentation options.
Parameters
- options: ForegroundPresentationOption[]
  The foreground options.
Returns Promise<void>
A promise.
- Defined in src/AirshipPush.ts:150

setForegroundPresentationOptionsCallback

setForegroundPresentationOptionsCallback(callback?): void
Overrides the presentation options per notification. If a null is returned, the default options will be used. The callback should return as quickly as possible to avoid delaying notification delivery.
Parameters
- Optional callback: ((pushPayload) => Promise<null | ForegroundPresentationOption[]>)
  A callback that can override the foreground presentation options.
  - - (pushPayload): Promise<null | ForegroundPresentationOption[]>
    - Parameters
      pushPayload: PushPayload
      Returns Promise<null | ForegroundPresentationOption[]>
Returns void
- Defined in src/AirshipPush.ts:137

setNotificationOptions

setNotificationOptions(options): Promise<void>
Sets the notification options.
Parameters
- options: NotificationOption[]
  The notification options.
Returns Promise<void>
A promise.
- Defined in src/AirshipPush.ts:161

Class AirshipPushIOS

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AirshipPushIOS

Properties

Private eventEmitter

Private Readonly module

Private Optional presentationOverridesCallback

Type declaration

Parameters

Returns Promise<null | ForegroundPresentationOption[]>

Methods

getAuthorizedNotificationSettings

Returns Promise<AuthorizedNotificationSetting[]>

getAuthorizedNotificationStatus

Returns Promise<AuthorizedNotificationStatus>

getBadgeNumber

Returns Promise<number>

isAutobadgeEnabled

Returns Promise<boolean>

setAutobadgeEnabled

Parameters

Returns Promise<void>

setBadgeNumber

Parameters

Returns Promise<void>

setForegroundPresentationOptions

Parameters

Returns Promise<void>

setForegroundPresentationOptionsCallback

Parameters

Parameters

Returns Promise<null | ForegroundPresentationOption[]>

Returns void

setNotificationOptions

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` eventEmitter

`Private` `Readonly` module

`Private` `Optional` presentationOverridesCallback