Class AirshipPreferenceCenter

Airship Preference Center.

Hierarchy

AirshipPreferenceCenter

Index

Constructors

Properties

Methods

display getConfig onDisplay setAutoLaunchDefaultPreferenceCenter

Constructors

constructor

new AirshipPreferenceCenter(plugin: AirshipPluginWrapper): AirshipPreferenceCenter
Parameters
- plugin: AirshipPluginWrapper
Returns AirshipPreferenceCenter
- Defined in AirshipPreferenceCenter.ts:10

Properties

`Private` `Readonly` plugin

plugin: AirshipPluginWrapper

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.

Returns
A promise.
Parameters
- preferenceCenterId: string
  
  The preference center Id.
Returns Promise<void>
- Defined in AirshipPreferenceCenter.ts:21

getConfig

getConfig(preferenceCenterId: string): Promise<PreferenceCenter>
Gets the preference center config.

Returns
A promise with the result.
Parameters
- preferenceCenterId: string
  
  The preference center Id.
Returns Promise<PreferenceCenter>
- Defined in AirshipPreferenceCenter.ts:30

onDisplay

onDisplay(listener: ((event: DisplayPreferenceCenterEvent) => void)): Promise<PluginListenerHandle>
Adds a display message center listener.
Parameters
- listener: ((event: DisplayPreferenceCenterEvent) => void)
  - - (event: DisplayPreferenceCenterEvent): void
    - Parameters
      
      event: DisplayPreferenceCenterEvent
      
      Returns void
Returns Promise<PluginListenerHandle>
- Defined in AirshipPreferenceCenter.ts:57

setAutoLaunchDefaultPreferenceCenter

setAutoLaunchDefaultPreferenceCenter(preferenceCenterId: string, autoLaunch: boolean): Promise<void>
Enables or disables showing the OOTB UI when requested to display by either display or by a notification with some other action.

Returns
A promise with the result.
Parameters
- preferenceCenterId: string
  
  The preference center Id.
- autoLaunch: boolean
  
  true to show OOTB UI, false to emit events.
Returns Promise<void>
- Defined in AirshipPreferenceCenter.ts:44

Generated using TypeDoc