Airship Unity Plugin 10.0.0
  • AirshipSDK
  • AirshipPreferenceCenter
Public Member Functions | List of all members
AirshipSDK.AirshipPreferenceCenter Class Reference

Airship Preference Center. More...

Public Member Functions

void Display (string preferenceCenterId)
 Requests to display a preference center.
 
IEnumerator GetConfig (string preferenceCenterId, Action< PreferenceCenterConfig > onComplete, Action< Exception > onError=null)
 Gets the preference center config asynchronously using a coroutine.
 
void SetAutoLaunchDefaultPreferenceCenter (string preferenceCenterId, bool autoLaunch)
 Enables or disables showing the OOTB UI when requested to display by either Display or by a notification with some other action.
 

Detailed Description

Airship Preference Center.

Member Function Documentation

◆ Display()

void AirshipSDK.AirshipPreferenceCenter.Display ( string  preferenceCenterId)
inline

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
preferenceCenterIdThe preference center Id.

References AirshipSDK.List.

◆ GetConfig()

IEnumerator AirshipSDK.AirshipPreferenceCenter.GetConfig ( string  preferenceCenterId,
Action< PreferenceCenterConfig >  onComplete,
Action< Exception >  onError = null 
)
inline

Gets the preference center config asynchronously using a coroutine.

This method does not block Unity's main thread.

Parameters
preferenceCenterIdThe preference center Id.
onCompleteCallback invoked with the config when the operation completes.
onErrorOptional callback invoked if an error occurs.
Returns
A coroutine that can be started with StartCoroutine.

References AirshipSDK.List.

◆ SetAutoLaunchDefaultPreferenceCenter()

void AirshipSDK.AirshipPreferenceCenter.SetAutoLaunchDefaultPreferenceCenter ( string  preferenceCenterId,
bool  autoLaunch 
)
inline

Enables or disables showing the OOTB UI when requested to display by either Display or by a notification with some other action.

Parameters
preferenceCenterIdThe preference center Id.
autoLaunchtrue to show OOTB UI, false to emit events.

References AirshipSDK.List.


Generated on Wed Sep 2 2026 21:27:03 for Airship Unity Plugin by   doxygen 1.9.8