LocalityType

enum LocalityType : Enum


The network locality of a request or route.

Summary

Enum Values

DIRECT

Communication through this device, or through a direct peer-to-peer connection.

MIXED

Indicates that the underlying Traits for a HomeDevice or DeviceType have a combination of Locality Types(s)

PEER

Communication through a local hub peer that forwards requests and responses.

REMOTE

Communication outside the local network.

UNSPECIFIED

Unknown locality.

Public functions

LocalityType
valueOf(value: String)

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

Array<LocalityType>

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

Enum Values

DIRECT

val LocalityType.DIRECTLocalityType

Communication through this device, or through a direct peer-to-peer connection.

MIXED

val LocalityType.MIXEDLocalityType

Indicates that the underlying Traits for a HomeDevice or DeviceType have a combination of Locality Types(s)

PEER

val LocalityType.PEERLocalityType

Communication through a local hub peer that forwards requests and responses.

REMOTE

val LocalityType.REMOTELocalityType

Communication outside the local network.

UNSPECIFIED

val LocalityType.UNSPECIFIEDLocalityType

Unknown locality. When the SDK is initialized some devices might be in an UNSPECIFIED state until a Hub or Server is reachable to provide connectivity to the device. Devices in this state are not reachable and will fail interaction requests (commands/events).

Public functions

valueOf

fun valueOf(value: String): LocalityType

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<LocalityType>

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.