Class AirshipInApp

Airship InApp Experiences.

Index

Constructors

Properties

eventEmitter module pendingEmbedded pendingEmbeddedListeners

Methods

addEmbeddedReadyListener getDisplayInterval isEmbeddedReady isPaused setDisplayInterval setPaused

Constructors

constructor

new AirshipInApp(module, eventEmitter): AirshipInApp
Parameters
- module: any
- eventEmitter: UAEventEmitter
Returns AirshipInApp
- Defined in src/AirshipInApp.ts:15

Properties

`Private` `Readonly` eventEmitter

eventEmitter: UAEventEmitter

`Private` `Readonly` module

module: any

`Private` pendingEmbedded

pendingEmbedded: Map<string, PendingEmbedded[]> = ...

`Private` pendingEmbeddedListeners

pendingEmbeddedListeners: Map<string, ((pending) => any)[]> = ...

Methods

addEmbeddedReadyListener

addEmbeddedReadyListener(embeddedId, listener): Subscription
Adds a listener to listen for if an embedded ID is ready to display or not.
Parameters
- embeddedId: string
  The embedded ID to check.
- listener: ((isReady) => void)
  The listener.
  - - (isReady): void
    - Parameters
      isReady: boolean
      Returns void
Returns Subscription
A subscription that can be used to cancel the listener.
- Defined in src/AirshipInApp.ts:45

getDisplayInterval

getDisplayInterval(): Promise<number>
Gets the display interval.

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

isEmbeddedReady

isEmbeddedReady(embeddedId): boolean
Checks if embedded message is ready for the given ID.
Parameters
- embeddedId: string
  The embedded ID to check.
Returns boolean
true if one is ready, otherwise false.
- Defined in src/AirshipInApp.ts:73

isPaused

isPaused(): Promise<boolean>
Checks if messages are paused.

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

setDisplayInterval

setDisplayInterval(milliseconds): Promise<void>
Sets the display interval for messages.
Parameters
- milliseconds: number
  Display interval
Returns Promise<void>
A promise.
- Defined in src/AirshipInApp.ts:99

setPaused

setPaused(paused): Promise<void>
Pauses messages.
Parameters
- paused: boolean
  true to pause, false to resume.
Returns Promise<void>
A promise.
- Defined in src/AirshipInApp.ts:82