OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

enum OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum : Enum, ClusterEnum


The reason for an announcement.

Summary

Enum Values

SimpleAnnouncement

An OTA provider is announcing its presence.

UnknownValue

The enum value is out of range.

UpdateAvailable

An OTA provider is announcing that a new software image may be available that needs to be applied.

UrgentUpdateAvailable

An OTA provider is announcing that a new software image may be available that needs to be applied urgently.

Public functions

OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum
valueOf(value: String)

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

Array<OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum>

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

Public properties

open String
open String
open ULong

Enum Values

UnknownValue

val OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum.UnknownValueOtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

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.

UpdateAvailable

val OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum.UpdateAvailableOtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

An OTA provider is announcing that a new software image may be available that needs to be applied.

UrgentUpdateAvailable

val OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum.UrgentUpdateAvailableOtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

An OTA provider is announcing that a new software image may be available that needs to be applied urgently.

Public functions

valueOf

fun valueOf(value: String): OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum

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<OtaSoftwareUpdateRequestorTrait.AnnouncementReasonEnum>

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

traitId

open val traitIdString

typeName

open val typeNameString

value

open val valueULong