Class AirshipRoot

Airship

Hierarchy

AirshipRoot

Index

Constructors

Properties

actions analytics channel contact featureFlagManager inApp locale messageCenter plugin preferenceCenter privacyManager push

Methods

isFlying onDeepLink takeOff

Constructors

constructor

new AirshipRoot(plugin: AirshipPluginWrapper): AirshipRoot
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipRoot
- Defined in AirshipRoot.ts:34

Properties

`Readonly` actions

actions: AirshipActions

`Readonly` analytics

analytics: AirshipAnalytics

`Readonly` channel

channel: AirshipChannel

`Readonly` contact

contact: AirshipContact

`Readonly` featureFlagManager

featureFlagManager: AirshipFeatureFlagManager

`Readonly` inApp

inApp: AirshipInApp

`Readonly` locale

locale: AirshipLocale

`Readonly` messageCenter

messageCenter: AirshipMessageCenter

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

`Readonly` preferenceCenter

preferenceCenter: AirshipPreferenceCenter

`Readonly` privacyManager

privacyManager: AirshipPrivacyManager

`Readonly` push

push: AirshipPush

Methods

isFlying

isFlying(): Promise<boolean>
Checks if Airship is ready.

Returns
A promise with the result.

Returns Promise<boolean>
- Defined in AirshipRoot.ts:63

onDeepLink

onDeepLink(listener: ((event: DeepLinkEvent) => void)): Promise<PluginListenerHandle>
Adds a deep link listener.
Parameters
- listener: ((event: DeepLinkEvent) => void)
  - - (event: DeepLinkEvent): void
    - Parameters
      
      event: DeepLinkEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipRoot.ts:70

takeOff

takeOff(config: AirshipConfig): Promise<boolean>
Calls takeOff. If Airship is already configured for the app session, the new config will be applied on the next app init.

Returns
A promise with the result. true if airship is ready.
Parameters
- config: AirshipConfig
  
  The config.
Returns Promise<boolean>
- Defined in AirshipRoot.ts:55

Generated using TypeDoc