urbanairship-preference-center-core/com.urbanairship.preferencecenter/PreferenceCenter

PreferenceCenter

class PreferenceCenter : AirshipComponent(source)

Airship Preference Center.

Types

object Companion

fun interface OnOpenListener

Listener to override Preference Center open behavior.

Properties

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

val inputValidator: AirshipInputValidation.Validator

var openListener: PreferenceCenter.OnOpenListener?

Preference Center open listener.

Inherited properties

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

protected val context: Context

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

protected val dataStore: PreferenceDataStore

Functions

suspend fun getConfig(preferenceCenterId: String): PreferenceCenterConfig?

Returns the preference center config, or null if its not found.

getConfigPendingResult

fun getConfigPendingResult(preferenceCenterId: String): PendingResult<PreferenceCenterConfig>

Returns a PendingResult containing the configuration of the Preference Center form with the given preferenceCenterId.

onAirshipDeepLink

open override fun onAirshipDeepLink(uri: Uri): Boolean

fun open(preferenceCenterId: String)

Opens the Preference Center with the given preferenceCenterId.

Inherited functions

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun init()

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun onAirshipReady()

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

open fun tearDown()