Interface AirshipPreferenceCenter

Airship Preference Center.

Hierarchy

AirshipPreferenceCenter

Index

Methods

display getConfig onDisplay setAutoLaunchDefaultPreferenceCenter

Methods

display

display(preferenceCenterId: string, success?: (() => void), error?: ((err: string) => void)): 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.
- Optional success: (() => void)
  
  Success callback.
  - - (): void
    - Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1396

getConfig

getConfig(preferenceCenterId: string, success: ((config: PreferenceCenter) => void), error?: ((err: string) => void)): void
Gets the preference center config.
Parameters
- preferenceCenterId: string
  
  The preference center Id.
- success: ((config: PreferenceCenter) => void)
  
  Success callback.
  - - (config: PreferenceCenter): void
    - Parameters
      
      config: PreferenceCenter
      
      Returns void
- Optional error: ((err: string) => void)
  
  Error callback.
  - - (err: string): void
    - Parameters
      
      err: string
      
      Returns void
Returns void
- Defined in index.d.ts:1408

onDisplay

onDisplay(callback: ((event: DisplayPreferenceCenterEvent) => void)): Cancellable
Event when the message center a preference center is requested to display.

Returns
A cancellable that can be used to cancel the listener.
Parameters
- callback: ((event: DisplayPreferenceCenterEvent) => void)
  
  The callback.
  - - (event: DisplayPreferenceCenterEvent): void
    - Parameters
      
      event: DisplayPreferenceCenterEvent
      
      Returns void
Returns Cancellable
- Defined in index.d.ts:1431

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 index.d.ts:1420

Interface AirshipPreferenceCenter

Hierarchy

Index

Methods

Methods

display

Parameters

preferenceCenterId: string

Optional success: (() => void)

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

getConfig

Parameters

preferenceCenterId: string

success: ((config: PreferenceCenter) => void)

Parameters

config: PreferenceCenter

Returns void

Optional error: ((err: string) => void)

Parameters

err: string

Returns void

Returns void

onDisplay

Returns

Parameters

callback: ((event: DisplayPreferenceCenterEvent) => void)

Parameters

event: DisplayPreferenceCenterEvent

Returns void

Returns Cancellable

setAutoLaunchDefaultPreferenceCenter

Parameters

preferenceCenterId: string

autoLaunch: boolean

Returns void

Settings

Member Visibility

Theme

`Optional` success: (() => void)

`Optional` error: ((err: string) => void)

`Optional` error: ((err: string) => void)