Class AirshipPushIOS

iOS Push.

Hierarchy

AirshipPushIOS

Index

Constructors

Properties

Methods

getBadgeNumber getQuietTime isAutobadgeEnabled isQuietTimeEnabled onAuthorizedSettingsChanged setAutobadgeEnabled setBadgeNumber setForegroundPresentationOptions setNotificationOptions setQuietTime setQuietTimeEnabled

Constructors

constructor

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

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

Methods

getBadgeNumber

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

Returns
A promise with the result.

Returns Promise<number>
- Defined in AirshipPush.ts:212

getQuietTime

getQuietTime(): Promise<undefined | null | QuietTime>
Gets the quiet time settings.

Returns
A promise with the result.

Returns Promise<undefined | null | QuietTime>
- Defined in AirshipPush.ts:249

isAutobadgeEnabled

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

Returns
A promise with the result.

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

isQuietTimeEnabled

isQuietTimeEnabled(): Promise<void>
Checks if quiet time is enabled or not.

Returns
A promise with the result.

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

onAuthorizedSettingsChanged

onAuthorizedSettingsChanged(listener: ((event: AuthorizedNotificationSettingsChangedEvent) => void)): Promise<PluginListenerHandle>
Adds a authorized settings changed event listener.
Parameters
- listener: ((event: AuthorizedNotificationSettingsChangedEvent) => void)
  - - (event: AuthorizedNotificationSettingsChangedEvent): void
    - Parameters
      
      event: AuthorizedNotificationSettingsChangedEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPush.ts:256

setAutobadgeEnabled

setAutobadgeEnabled(enabled: boolean): Promise<void>
Enables/disables autobadge.

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

setBadgeNumber

setBadgeNumber(badge: number): Promise<void>
Set the badge number.

Returns
A promise.
Parameters
- badge: number
  
  The badge number.
Returns Promise<void>
- Defined in AirshipPush.ts:204

setForegroundPresentationOptions

setForegroundPresentationOptions(options: ForegroundPresentationOption[]): Promise<void>
Sets the foreground presentation options.

Returns
A promise.
Parameters
- options: ForegroundPresentationOption[]
  
  The foreground options.
Returns Promise<void>
- Defined in AirshipPush.ts:162

setNotificationOptions

setNotificationOptions(options: NotificationOption[]): Promise<void>
Sets the notification options.

Returns
A promise.
Parameters
- options: NotificationOption[]
  
  The notification options.
Returns Promise<void>
- Defined in AirshipPush.ts:176

setQuietTime

setQuietTime(quietTime: QuietTime): Promise<void>
Sets quiet time.

Returns
A promise with the result.
Parameters
- quietTime: QuietTime
  
  The quiet time.
Returns Promise<void>
- Defined in AirshipPush.ts:240

setQuietTimeEnabled

setQuietTimeEnabled(enabled: boolean): Promise<void>
Enables/disables quiet time.

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

Generated using TypeDoc