Interface CommandElement

A command describes a remote procedure call.

interface CommandElement {
    constructor: any;
    access?: Definition;
    asOf?: `${number}.${number}`;
    byteSize?: ByteSize;
    children?: BaseElement[] & ValueElement[];
    conformance?: Definition;
    constraint?: Definition;
    default?: FieldValue;
    description?: string;
    details?: string;
    direction?: "response" | "request";
    id: number;
    isGlobal?: boolean;
    isSeed?: boolean;
    name: string;
    quality?: Definition;
    response?: string;
    tag: "command";
    type?: string;
    until?: `${number}.${number}`;
    xref?: Specification.CrossReference;
}

Hierarchy (view full)

Implemented by

Constructors

constructor

Properties

access? asOf? byteSize? children? conformance? constraint? default? description? details? direction? id isGlobal? isSeed? name quality? response? tag type? until? xref?

Constructors

constructor

constructor: any

Properties

Optionalaccess

access?: Definition

Authorization limits.

OptionalasOf

asOf?: `${number}.${number}`

The first Matter specification in which this element appears.

OptionalbyteSize

byteSize?: ByteSize

Applies to numeric types.

Optionalchildren

children?: BaseElement[] & ValueElement[]

Child elements.

Optionalconformance

conformance?: Definition

Optionality control.

Optionalconstraint

constraint?: Definition

Limits on values.

Optionaldefault

default?: FieldValue

The default value for the element.

Optionaldescription

description?: string

A short summary of the element.

Optionaldetails

details?: string

A paragraph summary of the element.

Optionaldirection

direction?: "response" | "request"

id

id: number

The ID of the element per Matter specification, either global or context-specific. A "machine appropriate" semantic differentiator.

OptionalisGlobal

isGlobal?: boolean

Is this a global element? Global elements are available in-scope for every cluster.

OptionalisSeed

isSeed?: boolean

Is this a "seed" element? These are global types and cluster elements defined in the core specification, without which we are fairly incapacitated.

name

name: string

The key used for storing this element. A "human appropriate" semantic differentiator.

Optionalquality

quality?: Definition

Other qualities not covered by conformance or access.

Optionalresponse

response?: string

tag

tag

Optionaltype

type?: string

If an element derives from another element, the name of the parent element goes here.

Optionaluntil

until?: `${number}.${number}`

The Matter specification revision in which this element was removed.

Optionalxref

xref?: Specification.CrossReference

Reference to Matter specification document.

Settings

Member Visibility

On This Page

Constructors
Properties