# ForcePermissionFlow


```
enum ForcePermissionFlow : Enum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.ForcePermissionFlow](https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow) |

*** ** * ** ***

Flows for forcing the permission-granting UI.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#DO_NOT_FORCE_LAUNCH` | If the user has a valid token, do not show the permission UI. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#FORCE_LAUNCH` | Show permission UI even if user has a valid token. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#FORCE_LAUNCH_OFFLINE_ACCESS` | Force launch the flow to obtain offline access token. |

| ### Public functions |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow` | `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow>` | `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow>` | `https://developers.home.google.com/reference/kotlin/com/google/home/ForcePermissionFlow#entries()` 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_LAUNCH: ForcePermissionFlow
```

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_LAUNCH: ForcePermissionFlow
```

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_ACCESS: ForcePermissionFlow
```

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 |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | 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 entries: EnumEntries<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.