ConnectivityState

enum ConnectivityState : Enum


Represents the state of a device (HomeDevice,Component,DeviceType,Trait).

Summary

Enum Values

OFFLINE

The device is offline.

ONLINE

The device is online.

PARTIALLY_ONLINE

The device is partially online.

UNKNOWN

The connectivity state is unknown.

Public functions

ConnectivityState
valueOf(value: String)

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

Array<ConnectivityState>

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

Enum Values

OFFLINE

val ConnectivityState.OFFLINEConnectivityState

The device is offline.

ONLINE

val ConnectivityState.ONLINEConnectivityState

The device is online.

PARTIALLY_ONLINE

val ConnectivityState.PARTIALLY_ONLINEConnectivityState

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.UNKNOWNConnectivityState

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
kotlin.IllegalArgumentException

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.