@espressif/rainmaker-base-cdf
    Preparing search index...

    Class default

    Index

    Constructors

    constructor

    Properties

    clearRegisteredTransports clearTransportsForNode nodeUpdates registerTransport transport unregisterTransport

    Accessors

    registeredTransports

    Methods

    getRegisteredTransportsSnapshot

    Constructors

    Properties

    clearRegisteredTransports: () => void = ...

    Clears the entire discovery transport registry (e.g. logout).

    clearTransportsForNode: (nodeId: string) => void = ...

    Clears all registered discovery transports for a node.

    Type Declaration

      • (nodeId: string): void

      • Parameters

        • nodeId: string

          CDF node id.

        Returns void

    nodeUpdates: { listen: (event: unknown) => void } = ...

    Type Declaration

    • listen: (event: unknown) => void

      Listens for node update events and routes them to appropriate handlers.

    registerTransport: (nodeId: string, transport: ESPCDFTransportConfig) => void = ...

    Persists a client-side transport for a node id.

    Type Declaration

    transport: {
        listen: (
            nodeId: { nodeId: string; transportDetails: ESPCDFTransportConfig },
        ) => void;
    } = ...

    Transport module to handle transport-related operations.

    Type Declaration

    • listen: (nodeId: { nodeId: string; transportDetails: ESPCDFTransportConfig }) => void

      Listens for transport details and updates the device store.

    unregisterTransport: (nodeId: string, transportType: string) => void = ...

    Removes one discovery transport for a node id.

    Type Declaration

      • (nodeId: string, transportType: string): void

      • Parameters

        • nodeId: string

          CDF node id.

        • transportType: string

          Transport map key to remove.

        Returns void

    Accessors

    registeredTransports: RegisteredTransportsByNodeId

    Client-registered transports by node id → transport type (local, matter_local, …). Survives cloud sync / node object replacement.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods