Interface Cluster

This cluster provides a means for a device to be told of the valid set of possible proxies that can proxy subscriptions on its behalf as per Section 9.15.7, “Proxy Discovery & Assignment Flow”.

See

MatterSpecification.v13.Core § 9.15.14

interface Cluster {
    attributes: Merge<{
        validProxyList: FixedAttribute<TypeFromFields<{
            nodeId: FieldType<NodeId>;
        }>[], any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {
        getValidProxiesRequest: Command<void, TypeFromFields<{
            proxyNodeIdList: FieldType<NodeId[]>;
        }>, any>;
    };
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<68, "ClusterId">;
    name: "ValidProxies";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        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<{
    validProxyList: FixedAttribute<TypeFromFields<{
        nodeId: FieldType<NodeId>;
    }>[], any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlyvalidProxyList: FixedAttribute<TypeFromFields<{
        nodeId: FieldType<NodeId>;
    }>[], any>

    List of valid proxies that can proxy this Node. Each entry in this list is fabric-scoped.

    See

    MatterSpecification.v13.Core § 9.15.14.5.1

base

base: undefined

commands

commands: {
    getValidProxiesRequest: Command<void, TypeFromFields<{
        proxyNodeIdList: FieldType<NodeId[]>;
    }>, any>;
}

Type declaration

  • ReadonlygetValidProxiesRequest: Command<void, TypeFromFields<{
        proxyNodeIdList: FieldType<NodeId[]>;
    }>, any>

    This command is used during proxy discovery, as specified in Section 9.15.7, “Proxy Discovery & Assignment Flow”.

    See

    MatterSpecification.v13.Core § 9.15.14.6.1

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<68, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          attributes: {
              validProxyList: FixedAttribute<TypeFromFields<{
                  nodeId: FieldType<NodeId>;
              }>[], any>;
          };
          commands: {
              getValidProxiesRequest: Command<void, TypeFromFields<{
                  proxyNodeIdList: FieldType<NodeId[]>;
              }>, any>;
          };
          id: 68;
          name: "ValidProxies";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {
          validProxyList: {
              nodeId: bigint;
          }[];
      }

    Parameters

    Returns WithValues<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    Parameters

    Returns Of<Of<{
        attributes: {
            validProxyList: FixedAttribute<TypeFromFields<{
                nodeId: FieldType<NodeId>;
            }>[], any>;
        };
        commands: {
            getValidProxiesRequest: Command<void, TypeFromFields<{
                proxyNodeIdList: FieldType<NodeId[]>;
            }>, any>;
        };
        id: 68;
        name: "ValidProxies";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods