# ConnectivityState

# ConnectivityState


```
enum ConnectivityState : 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.ConnectivityState](https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState) |

*** ** * ** ***

Represents the state of a device (`https://developers.home.google.com/reference/kotlin/com/google/home/HomeDevice`,Component,`https://developers.home.google.com/reference/kotlin/com/google/home/DeviceType`,`https://developers.home.google.com/reference/kotlin/com/google/home/Trait`).

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#OFFLINE` | The device is offline. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#ONLINE` | The device is online. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#PARTIALLY_ONLINE` | The device is partially online. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#UNKNOWN` | The connectivity state is unknown. |

| ### Public functions |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState` | `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#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/ConnectivityState>` | `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#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/ConnectivityState>` | `https://developers.home.google.com/reference/kotlin/com/google/home/ConnectivityState#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |

## Enum Values

### OFFLINE

```
val ConnectivityState.OFFLINE: ConnectivityState
```

The device is offline.

### ONLINE

```
val ConnectivityState.ONLINE: ConnectivityState
```

The device is online.

### PARTIALLY_ONLINE

```
val ConnectivityState.PARTIALLY_ONLINE: ConnectivityState
```

The device is partially online. This state means that some features on the device are online. This state will be returned for a device if at least one of the underlying features are online. To get more information about the device in this state, connectivity at more granular levels like DeviceType or Trait level should be analysed.

### UNKNOWN

```
val ConnectivityState.UNKNOWN: ConnectivityState
```

The connectivity state is unknown.

## Public functions

### valueOf

```
fun valueOf(value: String): ConnectivityState
```

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<ConnectivityState>
```

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<ConnectivityState>
```

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.