Interface EndpointInterface

The primary interface for Matter.js endpoint implementations.

TODO - this is a transitional interface that allows us to have multiple implementations of the legacy endpoint API

interface EndpointInterface {
    deviceType: DeviceTypeId;
    name: string;
    number: undefined | EndpointNumber;
    addChildEndpoint(endpoint: EndpointInterface): void;
    addClusterClient(client: ClusterClientObj): void;
    addClusterServer(server: ClusterServer): void;
    close(): void;
    determineUniqueID(): undefined | string;
    getAllClusterClients(): ClusterClientObj[];
    getAllClusterServers(): ClusterServer[];
    getChildEndpoint(id: EndpointNumber): undefined | EndpointInterface;
    getChildEndpoints(): EndpointInterface[];
    getClusterClient<const T>(cluster: T): undefined | ClusterClientObj<T>;
    getClusterServer<T>(cluster: T): undefined | ClusterServer;
    getClusterServerById(clusterId: ClusterId): undefined | ClusterServer;
    getNumber(): EndpointNumber;
    hasClusterServer(cluster: ClusterType): boolean;
    removeFromStructure(): void;
    setStructureChangedCallback(callback: (() => void)): void;
    updatePartsList(): EndpointNumber[];
    verifyRequiredClusters(): void;
}

Implemented by

Properties

deviceType name number

Methods

addChildEndpoint addClusterClient addClusterServer close determineUniqueID getAllClusterClients getAllClusterServers getChildEndpoint getChildEndpoints getClusterClient getClusterServer getClusterServerById getNumber hasClusterServer removeFromStructure setStructureChangedCallback updatePartsList verifyRequiredClusters

Properties

deviceType

deviceType: DeviceTypeId

name

name: string

number

number: undefined | EndpointNumber

Methods

addChildEndpoint

  • addChildEndpoint(endpoint): void

  • Parameters

    Returns void

addClusterClient

  • addClusterClient(client): void

  • Parameters

    Returns void

addClusterServer

  • addClusterServer(server): void

  • Parameters

    Returns void

close

  • close(): void

  • Returns void

determineUniqueID

  • determineUniqueID(): undefined | string

  • Returns undefined | string

getAllClusterClients

getAllClusterServers

  • getAllClusterServers(): ClusterServer[]

  • Returns ClusterServer[]

getChildEndpoint

getChildEndpoints

getClusterClient

  • getClusterClient<const T>(cluster): undefined | ClusterClientObj<T>

  • Type Parameters

    Parameters

    • cluster: T

    Returns undefined | ClusterClientObj<T>

getClusterServer

  • getClusterServer<T>(cluster): undefined | ClusterServer

  • Type Parameters

    Parameters

    • cluster: T

    Returns undefined | ClusterServer

getClusterServerById

  • getClusterServerById(clusterId): undefined | ClusterServer

  • Parameters

    Returns undefined | ClusterServer

getNumber

hasClusterServer

  • hasClusterServer(cluster): boolean

  • Parameters

    Returns boolean

removeFromStructure

  • removeFromStructure(): void

  • Returns void

setStructureChangedCallback

  • setStructureChangedCallback(callback): void

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

updatePartsList

verifyRequiredClusters

  • verifyRequiredClusters(): void

  • Returns void

Settings

Member Visibility

On This Page

Properties
Methods