Interface Cluster

This cluster provides a means for a proxy-capable device to be told the set of Nodes it shall proxy.

See

MatterSpecification.v13.Core § 9.15.13

interface Cluster {
    attributes: Merge<{
        configurationList: WritableAttribute<TypeFromFields<{
            proxyAllNodes: FieldType<boolean>;
            sourceList: FieldType<NodeId[]>;
        }>[], any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<66, "ClusterId">;
    name: "ProxyConfiguration";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        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<{
    configurationList: WritableAttribute<TypeFromFields<{
        proxyAllNodes: FieldType<boolean>;
        sourceList: FieldType<NodeId[]>;
    }>[], any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlyconfigurationList: WritableAttribute<TypeFromFields<{
        proxyAllNodes: FieldType<boolean>;
        sourceList: FieldType<NodeId[]>;
    }>[], any>

    List of proxy configurations. There shall NOT be multiple entries in this list for the same fabric.

    See

    MatterSpecification.v13.Core § 9.15.13.5.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<66, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              configurationList: WritableAttribute<TypeFromFields<{
                  proxyAllNodes: FieldType<boolean>;
                  sourceList: FieldType<NodeId[]>;
              }>[], any>;
          };
          id: 66;
          name: "ProxyConfiguration";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          configurationList: {
              proxyAllNodes: boolean;
              sourceList: bigint[];
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          attributes: {
              configurationList: WritableAttribute<TypeFromFields<{
                  proxyAllNodes: FieldType<boolean>;
                  sourceList: FieldType<NodeId[]>;
              }>[], any>;
          };
          id: 66;
          name: "ProxyConfiguration";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        attributes: {
            configurationList: WritableAttribute<TypeFromFields<{
                proxyAllNodes: FieldType<boolean>;
                sourceList: FieldType<NodeId[]>;
            }>[], any>;
        };
        id: 66;
        name: "ProxyConfiguration";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods