ForcePermissionFlow

enum ForcePermissionFlow : Enum


Flows for forcing the permission-granting UI.

Summary

Enum Values

DO_NOT_FORCE_LAUNCH

If the user has a valid token, do not show the permission UI.

FORCE_LAUNCH

Show permission UI even if user has a valid token.

FORCE_LAUNCH_OFFLINE_ACCESS

Force launch the flow to obtain offline access token.

Public functions

ForcePermissionFlow
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<ForcePermissionFlow>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

EnumEntries<ForcePermissionFlow>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Enum Values

DO_NOT_FORCE_LAUNCH

val ForcePermissionFlow.DO_NOT_FORCE_LAUNCHForcePermissionFlow

If the user has a valid token, do not show the permission UI. This is used for the regular application lifecycle, when the goal is to obtain a token to access currently granted structures, if available.

FORCE_LAUNCH

val ForcePermissionFlow.FORCE_LAUNCHForcePermissionFlow

Show permission UI even if user has a valid token. To be used in situation like, update permissions granted to the application, add permissions to new structures, etc.

FORCE_LAUNCH_OFFLINE_ACCESS

val ForcePermissionFlow.FORCE_LAUNCH_OFFLINE_ACCESSForcePermissionFlow

Force launch the flow to obtain offline access token. The offline access token is for a cloud server access and should not be required for regular app use cases.

Public functions

valueOf

fun valueOf(value: String): ForcePermissionFlow

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

fun values(): Array<ForcePermissionFlow>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entriesEnumEntries<ForcePermissionFlow>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.