UserLabel

interface UserLabel : UserLabelTrait.Attributes, MatterTrait, Updatable


API for the UserLabel trait. This trait provides an interface to tag an endpoint with zero or more labels.

Summary

Nested types

Descriptor enum for this trait's attributes.

Public functions

Boolean

Public properties

open TraitFactory<UserLabel>

Inherited functions

suspend Unit
suspend UserLabel
update(optimisticReturn: (UserLabel) -> Unit, init: UserLabelTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties

List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

UInt

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

List<UserLabelTrait.LabelStruct>?

Represents a list containing a minimum of 4 LabelStruct entries per node.

Public functions

supports

fun supports(attribute: UserLabel.Attribute): Boolean

Public properties

factory

open val factoryTraitFactory<UserLabel>