This cluster provides a feature to tag an endpoint with zero or more labels.

MatterSpecification.v13.Core § 9.9

interface Cluster {
    attributes: Merge<{
        labelList: WritableAttribute<TypeFromFields<{
            label: FieldType<string>;
            value: FieldType<string>;
        }>[], any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<65, "ClusterId">;
    name: "UserLabel";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes: Merge<{
    labelList: WritableAttribute<TypeFromFields<{
        label: FieldType<string>;
        value: FieldType<string>;
    }>[], any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlylabelList: WritableAttribute<TypeFromFields<{
        label: FieldType<string>;
        value: FieldType<string>;
    }>[], any>

    An implementation shall support at least 4 list entries per node for all User Label cluster instances on the node.

    MatterSpecification.v13.Core § 9.9.4.1

base: undefined
commands: {}
events: {}
extensions: undefined
features: {}
id: Branded<65, "ClusterId">
name
revision
supportedFeatures: {}
unknown

Methods