Class AirshipRoot

constructor

• new AirshipRoot(module: any): AirshipRoot

  Parameters

  • module: any

  Returns AirshipRoot

Readonlyactions

Readonlyanalytics

Readonlyandroid

Readonlychannel

Readonlycontact

ReadonlyfeatureFlagManager

ReadonlyinApp

ReadonlyiOS

Readonlylocale

ReadonlymessageCenter

ReadonlypreferenceCenter

ReadonlyprivacyManager

Readonlypush

addListener

• addListener<T extends EventType>(
      eventType: T,
      listener: (event: EventTypeMap[T]) => any,
  ): Subscription

  Adds a listener.

  Type Parameters

  • T extends EventType

  Parameters

  • eventType: T

    The listener type.

  • listener: (event: EventTypeMap[T]) => any

    The listener.

  Returns Subscription

  A subscription.

getLaunchDeepLink

• getLaunchDeepLink(): Promise<string | null | undefined>

  Returns the deep link that launched the app from a notification tap, or null if the app was not launched by a notification with a deep link.

  Only reflects a cold app launch or background-to-foreground launch triggered by the tap. A notification tapped while the app is already in the foreground will not be returned here; use the EventType.DeepLink listener below for that case.

  One-shot: the value is consumed on read. Intended to be wired as React Navigation's linking.getInitialURL, with an EventType.DeepLink listener as linking.subscribe:

  const linking = {
    prefixes: ['myapp://'],
    getInitialURL: () => Airship.getLaunchDeepLink(),
    subscribe: (listener) => {
      const subscription = Airship.addListener(
        EventType.DeepLink,
        (event) => listener(event.deepLink)
      );
      return () => subscription.remove();
    },
  };
  Copy

  Returns Promise<string | null | undefined>

  A promise with the launching deep link, or null.

isFlying

• isFlying(): Promise<boolean>

  Checks if Airship is ready.

  Returns Promise<boolean>

  A promise with the result.

removeAllListeners

• removeAllListeners(eventType: EventType): void

  Removes all listeners for a given type.

  Parameters

  • eventType: EventType

    The event type.

  Returns void

removeListener

• removeListener<T extends EventType>(
      eventType: EventType,
      listener: (event: EventTypeMap[T]) => any,
  ): void

  Removes a listener.

  Type Parameters

  • T extends EventType

  Parameters

  • eventType: EventType

    The event type.

  • listener: (event: EventTypeMap[T]) => any

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

  Returns void

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.

  Parameters

  • config: AirshipConfig

    The config.

  Returns Promise<boolean>

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