ClosureDimensionTrait.OverflowEnum

enum ClosureDimensionTrait.OverflowEnum : Enum, ClusterEnum

kotlin.Any
↳	kotlin.Enum
	↳	com.google.home.matter.standard.ClosureDimensionTrait.OverflowEnum

Describes the overflow state of a composed closure.

Summary

Enum Values
`BottomInside`	Bottom inside overflow.
`BottomOutside`	Bottom outside overflow.
`Inside`	Inside overflow.
`LeftInside`	Left inside overflow.
`LeftOutside`	Left outside overflow.
`NoOverflow`	No overflow.
`Outside`	Outside overflow.
`RightInside`	Right inside overflow.
`RightOutside`	Right outside overflow.
`TopInside`	Top inside overflow.
`TopOutside`	Top outside overflow.
`UnknownValue`	The enum value is out of range.

Public functions
`String`	`@HomeExperimentalGenericApi toDescription()`
`ClosureDimensionTrait.OverflowEnum`	`valueOf(value: String)` Returns the enum constant of this type with the specified name.
`Array<ClosureDimensionTrait.OverflowEnum>`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Public properties
`EnumEntries<ClosureDimensionTrait.OverflowEnum>`	`entries` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`open String`	`traitId` Trait identifier of the Matter Cluster that defines the enum Data Type.
`open String`	`typeName` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.
`open ULong`	`value` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.

Enum Values

BottomInside

val ClosureDimensionTrait.OverflowEnum.BottomInside: ClosureDimensionTrait.OverflowEnum

Bottom inside overflow. The panel pivots along its bottom edge, opening inward toward the interior of the room.

BottomOutside

val ClosureDimensionTrait.OverflowEnum.BottomOutside: ClosureDimensionTrait.OverflowEnum

Bottom outside overflow. The panel pivots along its bottom edge, opening outward away from the interior of the room.

Inside

val ClosureDimensionTrait.OverflowEnum.Inside: ClosureDimensionTrait.OverflowEnum

Inside overflow. The panel opens inward, pivoting from the outside toward the interior side.

LeftInside

val ClosureDimensionTrait.OverflowEnum.LeftInside: ClosureDimensionTrait.OverflowEnum

Left inside overflow. The left-hung panel opens inward, pivoting from the right toward the interior of the room.

LeftOutside

val ClosureDimensionTrait.OverflowEnum.LeftOutside: ClosureDimensionTrait.OverflowEnum

Left outside overflow. The panel opens outward, pivoting from the right exterior of the building.

NoOverflow

val ClosureDimensionTrait.OverflowEnum.NoOverflow: ClosureDimensionTrait.OverflowEnum

No overflow.

Outside

val ClosureDimensionTrait.OverflowEnum.Outside: ClosureDimensionTrait.OverflowEnum

Outside overflow. The panel opens outward, pivoting from the inside away from the interior side.

RightInside

val ClosureDimensionTrait.OverflowEnum.RightInside: ClosureDimensionTrait.OverflowEnum

Right inside overflow. The right-hung panel opens inward, pivoting from the left toward the interior of the room.

RightOutside

val ClosureDimensionTrait.OverflowEnum.RightOutside: ClosureDimensionTrait.OverflowEnum

Right outside overflow. The panel opens outward, pivoting from the left toward the exterior of the building.

TopInside

val ClosureDimensionTrait.OverflowEnum.TopInside: ClosureDimensionTrait.OverflowEnum

Top inside overflow. The panel pivots along its top edge, opening inward toward the interior of the room.

TopOutside

val ClosureDimensionTrait.OverflowEnum.TopOutside: ClosureDimensionTrait.OverflowEnum

Top outside overflow. The panel pivots along its top edge, opening outward away from the interior of the room.

UnknownValue

val ClosureDimensionTrait.OverflowEnum.UnknownValue: ClosureDimensionTrait.OverflowEnum

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

Public functions

toDescription

@HomeExperimentalGenericApi
fun toDescription(): String

valueOf

fun valueOf(value: String): ClosureDimensionTrait.OverflowEnum

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<ClosureDimensionTrait.OverflowEnum>

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<ClosureDimensionTrait.OverflowEnum>

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.

traitId

open val traitId: String

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.

typeName

open val typeName: String

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

value

open val value: ULong

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.