Class AirshipPreferenceCenter

Airship Preference Center.

Index

Constructors

Methods

display getConfig setAutoLaunchDefaultPreferenceCenter

Constructors

constructor

new AirshipPreferenceCenter(module: any): AirshipPreferenceCenter
Parameters
- module: any
Returns AirshipPreferenceCenter
- Defined in src/AirshipPreferenceCenter.ts:7

Methods

display

display(preferenceCenterId: string): Promise<void>
Requests to display a preference center.

Will either emit an event to display the Preference Center if auto launch is disabled, or display the OOTB UI.
Parameters
- preferenceCenterId: string
  The preference center Id.
Returns Promise<void>
A promise.
- Defined in src/AirshipPreferenceCenter.ts:18

getConfig

getConfig(preferenceCenterId: string): Promise<PreferenceCenter>
Gets the preference center config.
Parameters
- preferenceCenterId: string
  The preference center Id.
Returns Promise<PreferenceCenter>
A promise with the result.
- Defined in src/AirshipPreferenceCenter.ts:27

setAutoLaunchDefaultPreferenceCenter

setAutoLaunchDefaultPreferenceCenter(
preferenceCenterId: string,
autoLaunch: boolean,
): void
Enables or disables showing the OOTB UI when requested to display by either display or by a notification with some other action.
Parameters
- preferenceCenterId: string
  The preference center Id.
- autoLaunch: boolean
  true to show OOTB UI, false to emit events.
Returns void
- Defined in src/AirshipPreferenceCenter.ts:37