Interface Cluster

This cluster contains commands needed to do proxy discovery as defined in the Section 9.15.7.3, “Step 2: Proxy Discovery” and Section 9.15.7.4, “Step 3: Proxy Response” steps of the overall Section 9.15.7, “Proxy Discovery & Assignment Flow”.

See

MatterSpecification.v13.Core § 9.15.12

interface Cluster {
    attributes: {};
    base: undefined;
    commands: {
        proxyDiscoverRequest: Command<TypeFromFields<{
            numAttributePaths: FieldType<number>;
            numEventPaths: FieldType<number>;
            sourceNodeId: FieldType<NodeId>;
        }>, void, any>;
    };
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<67, "ClusterId">;
    name: "ProxyDiscovery";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        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: {}

base

base: undefined

commands

commands: {
    proxyDiscoverRequest: Command<TypeFromFields<{
        numAttributePaths: FieldType<number>;
        numEventPaths: FieldType<number>;
        sourceNodeId: FieldType<NodeId>;
    }>, void, any>;
}

Type declaration

  • ReadonlyproxyDiscoverRequest: Command<TypeFromFields<{
        numAttributePaths: FieldType<number>;
        numEventPaths: FieldType<number>;
        sourceNodeId: FieldType<NodeId>;
    }>, void, 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.12.4.1

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<67, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

  • alter<const AlterationsT>(alterations): WithAlterations<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, AlterationsT>

  • Modify elements using ElementModifier.alter.

    Type Parameters

    • const AlterationsT extends Alterations<Of<{
          commands: {
              proxyDiscoverRequest: Command<TypeFromFields<{
                  numAttributePaths: FieldType<number>;
                  numEventPaths: FieldType<number>;
                  sourceNodeId: FieldType<NodeId>;
              }>, void, any>;
          };
          id: 67;
          name: "ProxyDiscovery";
          revision: 1;
      }>>

    Parameters

    Returns WithAlterations<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, AlterationsT>

enable

  • enable<const FlagsT>(flags): WithFlags<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, FlagsT>

  • Modify elements using ElementModifier.enable.

    Type Parameters

    • const FlagsT extends ElementFlags<Of<{
          commands: {
              proxyDiscoverRequest: Command<TypeFromFields<{
                  numAttributePaths: FieldType<number>;
                  numEventPaths: FieldType<number>;
                  sourceNodeId: FieldType<NodeId>;
              }>, void, any>;
          };
          id: 67;
          name: "ProxyDiscovery";
          revision: 1;
      }>>

    Parameters

    Returns WithFlags<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, FlagsT>

set

  • set<const ValuesT>(values): WithValues<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, ValuesT>

  • Modify elements using ElementModifier.set.

    Type Parameters

    • const ValuesT extends {}

    Parameters

    Returns WithValues<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, ValuesT>

with

  • with<const SelectionT>(...selection): Of<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, SelectionT>

  • Select features using ClusterComposer.compose.

    Type Parameters

    • const SelectionT extends FeatureSelection<Of<{
          commands: {
              proxyDiscoverRequest: Command<TypeFromFields<{
                  numAttributePaths: FieldType<number>;
                  numEventPaths: FieldType<number>;
                  sourceNodeId: FieldType<NodeId>;
              }>, void, any>;
          };
          id: 67;
          name: "ProxyDiscovery";
          revision: 1;
      }>>

    Parameters

    Returns Of<Of<{
        commands: {
            proxyDiscoverRequest: Command<TypeFromFields<{
                numAttributePaths: FieldType<number>;
                numEventPaths: FieldType<number>;
                sourceNodeId: FieldType<NodeId>;
            }>, void, any>;
        };
        id: 67;
        name: "ProxyDiscovery";
        revision: 1;
    }>, SelectionT>

Settings

Member Visibility

On This Page

Properties
Methods