Interface Cluster

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

See

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 base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

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.

    See

    MatterSpecification.v13.Core § 9.9.4.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<65, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              labelList: WritableAttribute<TypeFromFields<{
                  label: FieldType<string>;
                  value: FieldType<string>;
              }>[], any>;
          };
          id: 65;
          name: "UserLabel";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          labelList: {
              label: string;
              value: string;
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              labelList: WritableAttribute<TypeFromFields<{
                  label: FieldType<string>;
                  value: FieldType<string>;
              }>[], any>;
          };
          id: 65;
          name: "UserLabel";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            labelList: WritableAttribute<TypeFromFields<{
                label: FieldType<string>;
                value: FieldType<string>;
            }>[], any>;
        };
        id: 65;
        name: "UserLabel";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods