ClosureDimensionTrait.RotationAxisEnum

enum ClosureDimensionTrait.RotationAxisEnum : Enum, ClusterEnum

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

Describes the axis of rotation of a panel.

Summary

Enum Values
`Bottom`	The panel rotates around a horizontal axis located on the bottom of the panel.
`CenteredHorizontal`	The panel rotates around a horizontal axis located in the center of the panel.
`CenteredVertical`	The panel rotates around a vertical axis located in the center of the panel.
`Left`	The panel rotates around a vertical axis located on the left side of the panel.
`LeftAndRight`	The panel rotates around two vertical axes, one on the left side and one on the right side of the panel.
`LeftAndRightBarriers`	The dual barriers tilt around axes located at each side of the composite barrier.
`LeftBarrier`	The barrier tilts around an axis located at the left end of the barrier.
`Right`	The panel rotates around a vertical axis located on the right side of the panel.
`RightBarrier`	The barrier tilts around an axis located on the right barrier of the panel.
`Top`	The panel rotates around a horizontal axis located on the top of the panel.
`TopAndBottom`	The panel rotates around two horizontal axes, one on the top and one on the bottom of the panel.
`UnknownValue`	The enum value is out of range.

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

Public properties
`EnumEntries<ClosureDimensionTrait.RotationAxisEnum>`	`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

Bottom

val ClosureDimensionTrait.RotationAxisEnum.Bottom: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a horizontal axis located on the bottom of the panel.

CenteredHorizontal

val ClosureDimensionTrait.RotationAxisEnum.CenteredHorizontal: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a horizontal axis located in the center of the panel.

CenteredVertical

val ClosureDimensionTrait.RotationAxisEnum.CenteredVertical: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a vertical axis located in the center of the panel.

Left

val ClosureDimensionTrait.RotationAxisEnum.Left: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a vertical axis located on the left side of the panel.

LeftAndRight

val ClosureDimensionTrait.RotationAxisEnum.LeftAndRight: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around two vertical axes, one on the left side and one on the right side of the panel.

LeftAndRightBarriers

val ClosureDimensionTrait.RotationAxisEnum.LeftAndRightBarriers: ClosureDimensionTrait.RotationAxisEnum

The dual barriers tilt around axes located at each side of the composite barrier.

LeftBarrier

val ClosureDimensionTrait.RotationAxisEnum.LeftBarrier: ClosureDimensionTrait.RotationAxisEnum

The barrier tilts around an axis located at the left end of the barrier.

Right

val ClosureDimensionTrait.RotationAxisEnum.Right: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a vertical axis located on the right side of the panel.

RightBarrier

val ClosureDimensionTrait.RotationAxisEnum.RightBarrier: ClosureDimensionTrait.RotationAxisEnum

The barrier tilts around an axis located on the right barrier of the panel.

Top

val ClosureDimensionTrait.RotationAxisEnum.Top: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around a horizontal axis located on the top of the panel.

TopAndBottom

val ClosureDimensionTrait.RotationAxisEnum.TopAndBottom: ClosureDimensionTrait.RotationAxisEnum

The panel rotates around two horizontal axes, one on the top and one on the bottom of the panel.

UnknownValue

val ClosureDimensionTrait.RotationAxisEnum.UnknownValue: ClosureDimensionTrait.RotationAxisEnum

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

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

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

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.