Class AirshipRoot

constructor

• new AirshipRoot(module): AirshipRoot

• Parameters

  • module: any

  Returns AirshipRoot

Readonly actions

Readonly analytics

Readonly channel

Readonly contact

Readonly featureFlagManager

Readonly inApp

Readonly locale

Readonly messageCenter

Readonly preferenceCenter

Readonly privacyManager

Readonly push

addListener

• addListener<T>(eventType, listener): Subscription

• Adds a listener.

  Type Parameters

  • T extends EventType

  Parameters

  • eventType: T

    The listener type.
  • listener: ((event) => any)

    The listener.

    • • (event): any

      • Parameters

        • event: EventTypeMap[T]

        Returns any

  Returns Subscription

  A subscription.

isFlying

• isFlying(): Promise<boolean>

• Checks if Airship is ready.

  Returns Promise<boolean>

  A promise with the result.

removeAllListeners

• removeAllListeners(eventType): void

• Removes all listeners for a given type.

  Parameters

  • eventType: EventType

    The event type.

  Returns void

removeListener

• removeListener<T>(eventType, listener): void

• Removes a listener.

  Type Parameters

  • T extends EventType

  Parameters

  • eventType: EventType

    The event type.
  • listener: ((event) => any)

    The event listener. Should be a reference to the function passed into addListener.

    • • (event): any

      • Parameters

        • event: EventTypeMap[T]

        Returns any

  Returns void

takeOff

• takeOff(config): Promise<boolean>

• Calls takeOff. If Airship is already configured for the app session, the new config will be applied on the next app init.

  Parameters

  • config: AirshipConfig

    The config.

  Returns Promise<boolean>

  A promise with the result. true if airship is ready.