Class AirshipInApp

Airship InApp Experiences.

Index

Constructors

Methods

addEmbeddedReadyListener addPendingEmbeddedListener getDisplayInterval getPendingEmbedded isEmbeddedReady isPaused setDisplayInterval setPaused

Constructors

constructor

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

Methods

addEmbeddedReadyListener

addEmbeddedReadyListener(
embeddedId: string,
listener: (isReady: boolean) => void,
): 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: boolean) => void
  The listener.
Returns Subscription
A subscription that can be used to cancel the listener.
- Defined in src/AirshipInApp.ts:97

addPendingEmbeddedListener

addPendingEmbeddedListener(
embeddedId: string,
listener: (pending: PendingEmbedded[]) => void,
): Subscription
Adds a listener that is called whenever the list of pending embedded content changes for the given embedded ID.
Parameters
- embeddedId: string
  The embedded ID to watch.
- listener: (pending: PendingEmbedded[]) => void
  The listener, called with the current pending list.
Returns Subscription
A subscription that can be used to cancel the listener.
- Defined in src/AirshipInApp.ts:77

getDisplayInterval

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

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

getPendingEmbedded

getPendingEmbedded(embeddedId: string): PendingEmbedded[]
Gets the pending embedded content info for the given embedded ID.
Parameters
- embeddedId: string
  The embedded ID to check.
Returns PendingEmbedded[]
The pending embedded content info, including instance ID and extras.
- Defined in src/AirshipInApp.ts:66

isEmbeddedReady

isEmbeddedReady(embeddedId: string): 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:125

isPaused

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

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

setDisplayInterval

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

setPaused

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