ConsentScreenOptions

data class ConsentScreenOptions : Parcelable

ConsentScreenOptions is a class that holds the information about the options for the consent screen in the permissions flow.

Summary

Public companion functions
`ConsentScreenOptions`	`create( structureId: String?, allowedStructureIds: List<String>?, isAllowStructureChange: Boolean, invitationToken: String?, appScope: String?, locale: String? )` Creates a ConsentScreenOptions instance.

Public companion properties
`Parcelable.Creator<ConsentScreenOptions>`	`CREATOR`

Public constructors
`ConsentScreenOptions( structureId: String?, allowedStructureIds: List<String>?, isAllowStructureChange: Boolean, invitationToken: String?, appScope: String?, locale: String? )`

Public functions
`open Unit`	`writeToParcel(dest: Parcel, flags: Int)`

Public properties
`List<String>?`	`allowedStructureIds` Optional list of HGS structure IDs to filter the selection.
`String?`	`appScope` Optional application scope to be associated with the current permissions flow.
`String?`	`invitationToken` Optional invitation token to be used for accepting an invitation.
`Boolean`	`isAllowStructureChange` Whether the user is allowed to change the preselected structure.
`String?`	`locale` Optional BCP-47 language tag the webview screen should be rendered in.
`String?`	`structureId` Optional HGS structure ID to preselect.

Public companion functions

create

fun create(
    structureId: String? = null,
    allowedStructureIds: List<String>? = null,
    isAllowStructureChange: Boolean = false,
    invitationToken: String? = null,
    appScope: String? = null,
    locale: String? = null
): ConsentScreenOptions

Creates a ConsentScreenOptions instance.

Parameters
`structureId: String? = null`	Optional HGS structure ID to preselect.
`allowedStructureIds: List<String>? = null`	Optional list of HGS structure IDs to filter the selection.
`isAllowStructureChange: Boolean = false`	Whether the user is allowed to change the preselected structure.
`invitationToken: String? = null`	Optional invitation token to be used for accepting an invitation.
`appScope: String? = null`	Optional application scope to be associated with the current permissions flow.
`locale: String? = null`	Optional BCP-47 language tag the webview should be rendered in.

Public companion properties

CREATOR

val CREATOR: Parcelable.Creator<ConsentScreenOptions>

Public constructors

ConsentScreenOptions

ConsentScreenOptions(
    structureId: String?,
    allowedStructureIds: List<String>?,
    isAllowStructureChange: Boolean,
    invitationToken: String? = null,
    appScope: String? = null,
    locale: String? = null
)

Public functions

writeToParcel

open fun writeToParcel(dest: Parcel, flags: Int): Unit

Public properties

allowedStructureIds

val allowedStructureIds: List<String>?

Optional list of HGS structure IDs to filter the selection.

appScope

val appScope: String?

Optional application scope to be associated with the current permissions flow.

invitationToken

val invitationToken: String?

Optional invitation token to be used for accepting an invitation.

isAllowStructureChange

val isAllowStructureChange: Boolean

Whether the user is allowed to change the preselected structure.

locale

val locale: String?

Optional BCP-47 language tag the webview screen should be rendered in. When absent, will fallback to the device locale.

structureId

val structureId: String?

Optional HGS structure ID to preselect.