Constructors

Properties

address: PeerAddress

Accessors

  • get channelType(): ChannelType
  • Returns ChannelType

  • get channelUpdated(): Observable<[void], void>
  • Returns Observable<[void], void>

  • get maxKnownEventNumber(): undefined | EventNumber
  • Returns undefined | EventNumber

  • get session(): Session
  • Returns Session

Methods

  • Returns void

  • Parameters

    • Optionaloptions: {
          dataVersionFilters?: {
              clusterId: ClusterId;
              dataVersion: number;
              endpointId: EndpointNumber;
          }[];
          enrichCachedAttributeData?: boolean;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
      }
      • OptionaldataVersionFilters?: {
            clusterId: ClusterId;
            dataVersion: number;
            endpointId: EndpointNumber;
        }[]
      • OptionalenrichCachedAttributeData?: boolean
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean

    Returns Promise<DecodedAttributeReportValue<any>[]>

  • Parameters

    • Optionaloptions: {
          dataVersionFilters?: {
              clusterId: ClusterId;
              dataVersion: number;
              endpointId: EndpointNumber;
          }[];
          enrichCachedAttributeData?: boolean;
          eventFilters?: TypeFromFields<{
              eventMin: FieldType<number | bigint>;
              nodeId: OptionalFieldType<NodeId>;
          }>[];
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
      }
      • OptionaldataVersionFilters?: {
            clusterId: ClusterId;
            dataVersion: number;
            endpointId: EndpointNumber;
        }[]
      • OptionalenrichCachedAttributeData?: boolean
      • OptionaleventFilters?: TypeFromFields<{
            eventMin: FieldType<number | bigint>;
            nodeId: OptionalFieldType<NodeId>;
        }>[]
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean

    Returns Promise<{
        attributeReports: DecodedAttributeReportValue<any>[];
        eventReports: DecodedEventReportValue<any>[];
    }>

  • Type Parameters

    Parameters

    • options: {
          alwaysRequestFromRemote?: boolean;
          attribute: A;
          clusterId: ClusterId;
          endpointId: EndpointNumber;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
      }
      • OptionalalwaysRequestFromRemote?: boolean
      • attribute: A
      • clusterId: ClusterId
      • endpointId: EndpointNumber
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean

    Returns Promise<undefined | AttributeJsType<A>>

  • Type Parameters

    Parameters

    • options: {
          alwaysRequestFromRemote?: boolean;
          attribute: A;
          clusterId: ClusterId;
          endpointId: EndpointNumber;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
      }
      • OptionalalwaysRequestFromRemote?: boolean
      • attribute: A
      • clusterId: ClusterId
      • endpointId: EndpointNumber
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean

    Returns Promise<undefined | {
        value: AttributeJsType<A>;
        version: number;
    }>

  • Returns the list (optionally filtered by endpointId and/or clusterId) of the dataVersions of the currently cached values to use them as knownDataVersion for read or subscription requests.

    Parameters

    Returns {
        clusterId: ClusterId;
        dataVersion: number;
        endpointId: EndpointNumber;
    }[]

  • Type Parameters

    Parameters

    • options: {
          clusterId: ClusterId;
          endpointId: EndpointNumber;
          event: E;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
          minimumEventNumber?: EventNumber;
      }

    Returns Promise<undefined | DecodedEventData<T>[]>

  • Parameters

    • Optionaloptions: {
          attributes?: {
              attributeId?: AttributeId;
              clusterId?: ClusterId;
              endpointId?: EndpointNumber;
          }[];
          dataVersionFilters?: {
              clusterId: ClusterId;
              dataVersion: number;
              endpointId: EndpointNumber;
          }[];
          enrichCachedAttributeData?: boolean;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
      }
      • Optionalattributes?: {
            attributeId?: AttributeId;
            clusterId?: ClusterId;
            endpointId?: EndpointNumber;
        }[]
      • OptionaldataVersionFilters?: {
            clusterId: ClusterId;
            dataVersion: number;
            endpointId: EndpointNumber;
        }[]
      • OptionalenrichCachedAttributeData?: boolean
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean

    Returns Promise<DecodedAttributeReportValue<any>[]>

  • Type Parameters

    Parameters

    • options: {
          asTimedRequest?: boolean;
          clusterId: ClusterId;
          command: C;
          endpointId: EndpointNumber;
          executeQueued?: boolean;
          request: RequestType<C>;
          timedRequestTimeoutMs?: number;
          useExtendedFailSafeMessageResponseTimeout?: boolean;
      }
      • OptionalasTimedRequest?: boolean
      • clusterId: ClusterId
      • command: C
      • endpointId: EndpointNumber
      • OptionalexecuteQueued?: boolean
      • request: RequestType<C>
      • OptionaltimedRequestTimeoutMs?: number
      • OptionaluseExtendedFailSafeMessageResponseTimeout?: boolean

    Returns Promise<ResponseType<C>>

  • Type Parameters

    Parameters

    • options: {
          asTimedRequest?: boolean;
          clusterId: ClusterId;
          command: C;
          endpointId: EndpointNumber;
          executeQueued?: boolean;
          request: RequestType<C>;
          timedRequestTimeoutMs?: number;
      }
      • OptionalasTimedRequest?: boolean
      • clusterId: ClusterId
      • command: C
      • endpointId: EndpointNumber
      • OptionalexecuteQueued?: boolean
      • request: RequestType<C>
      • OptionaltimedRequestTimeoutMs?: number

    Returns Promise<void>

  • Returns void

  • Parameters

    • subscriptionId: number

    Returns void

  • Type Parameters

    • T

    Parameters

    • options: {
          asTimedRequest?: boolean;
          attributeData: {
              attribute: Attribute<T, any>;
              clusterId: ClusterId;
              dataVersion?: number;
              endpointId: EndpointNumber;
              value: T;
          };
          executeQueued?: boolean;
          suppressResponse?: boolean;
          timedRequestTimeoutMs?: number;
      }
      • OptionalasTimedRequest?: boolean
      • attributeData: {
            attribute: Attribute<T, any>;
            clusterId: ClusterId;
            dataVersion?: number;
            endpointId: EndpointNumber;
            value: T;
        }
      • OptionalexecuteQueued?: boolean
      • OptionalsuppressResponse?: boolean
      • OptionaltimedRequestTimeoutMs?: number

    Returns Promise<void>

  • Parameters

    • options: {
          asTimedRequest?: boolean;
          attributes: {
              attribute: Attribute<any, any>;
              clusterId: ClusterId;
              dataVersion?: number;
              endpointId: EndpointNumber;
              value: any;
          }[];
          executeQueued?: boolean;
          suppressResponse?: boolean;
          timedRequestTimeoutMs?: number;
      }
      • OptionalasTimedRequest?: boolean
      • attributes: {
            attribute: Attribute<any, any>;
            clusterId: ClusterId;
            dataVersion?: number;
            endpointId: EndpointNumber;
            value: any;
        }[]
      • OptionalexecuteQueued?: boolean
      • OptionalsuppressResponse?: boolean
      • OptionaltimedRequestTimeoutMs?: number

    Returns Promise<AttributeStatus[]>

  • Parameters

    • options: {
          attributeListener?: ((data: DecodedAttributeReportValue<any>, valueChanged?: boolean, oldValue?: unknown) => void);
          dataVersionFilters?: {
              clusterId: ClusterId;
              dataVersion: number;
              endpointId: EndpointNumber;
          }[];
          enrichCachedAttributeData?: boolean;
          eventFilters?: TypeFromFields<{
              eventMin: FieldType<number | bigint>;
              nodeId: OptionalFieldType<NodeId>;
          }>[];
          eventListener?: ((data: DecodedEventReportValue<any>) => void);
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
          isUrgent?: boolean;
          keepSubscriptions?: boolean;
          maxIntervalCeilingSeconds: number;
          minIntervalFloorSeconds: number;
          updateReceived?: (() => void);
          updateTimeoutHandler?: Callback;
      }
      • OptionalattributeListener?: ((data: DecodedAttributeReportValue<any>, valueChanged?: boolean, oldValue?: unknown) => void)
          • (data, valueChanged?, oldValue?): void
          • Parameters

            Returns void

      • OptionaldataVersionFilters?: {
            clusterId: ClusterId;
            dataVersion: number;
            endpointId: EndpointNumber;
        }[]
      • OptionalenrichCachedAttributeData?: boolean
      • OptionaleventFilters?: TypeFromFields<{
            eventMin: FieldType<number | bigint>;
            nodeId: OptionalFieldType<NodeId>;
        }>[]
      • OptionaleventListener?: ((data: DecodedEventReportValue<any>) => void)
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean
      • OptionalisUrgent?: boolean
      • OptionalkeepSubscriptions?: boolean
      • maxIntervalCeilingSeconds: number
      • minIntervalFloorSeconds: number
      • OptionalupdateReceived?: (() => void)
          • (): void
          • Returns void

      • OptionalupdateTimeoutHandler?: Callback

    Returns Promise<{
        attributeReports?: DecodedAttributeReportValue<any>[];
        eventReports?: DecodedEventReportValue<any>[];
    }>

  • Type Parameters

    Parameters

    • options: {
          attribute: A;
          clusterId: ClusterId;
          endpointId: EndpointNumber;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
          keepSubscriptions?: boolean;
          knownDataVersion?: number;
          listener?: ((value: AttributeJsType<A>, version: number) => void);
          maxIntervalCeilingSeconds: number;
          minIntervalFloorSeconds: number;
          updateReceived?: (() => void);
          updateTimeoutHandler?: Callback;
      }
      • attribute: A
      • clusterId: ClusterId
      • endpointId: EndpointNumber
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean
      • OptionalkeepSubscriptions?: boolean
      • OptionalknownDataVersion?: number
      • Optionallistener?: ((value: AttributeJsType<A>, version: number) => void)
          • (value, version): void
          • Parameters

            Returns void

      • maxIntervalCeilingSeconds: number
      • minIntervalFloorSeconds: number
      • OptionalupdateReceived?: (() => void)
          • (): void
          • Returns void

      • OptionalupdateTimeoutHandler?: Callback

    Returns Promise<void>

  • Type Parameters

    Parameters

    • options: {
          clusterId: ClusterId;
          endpointId: EndpointNumber;
          event: E;
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
          isUrgent?: boolean;
          listener?: ((value: DecodedEventData<T>) => void);
          maxIntervalCeilingSeconds: number;
          minimumEventNumber?: EventNumber;
          minIntervalFloorSeconds: number;
          updateReceived?: (() => void);
          updateTimeoutHandler?: Callback;
      }
      • clusterId: ClusterId
      • endpointId: EndpointNumber
      • event: E
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean
      • OptionalisUrgent?: boolean
      • Optionallistener?: ((value: DecodedEventData<T>) => void)
      • maxIntervalCeilingSeconds: number
      • OptionalminimumEventNumber?: EventNumber
      • minIntervalFloorSeconds: number
      • OptionalupdateReceived?: (() => void)
          • (): void
          • Returns void

      • OptionalupdateTimeoutHandler?: Callback

    Returns Promise<void>

  • Parameters

    • options: {
          attributeListener?: ((data: DecodedAttributeReportValue<any>, valueChanged?: boolean, oldValue?: any) => void);
          attributes: {
              attributeId?: AttributeId;
              clusterId?: ClusterId;
              endpointId?: EndpointNumber;
          }[];
          dataVersionFilters?: {
              clusterId: ClusterId;
              dataVersion: number;
              endpointId: EndpointNumber;
          }[];
          enrichCachedAttributeData?: boolean;
          eventFilters?: TypeFromFields<{
              eventMin: FieldType<number | bigint>;
              nodeId: OptionalFieldType<NodeId>;
          }>[];
          eventListener?: ((data: DecodedEventReportValue<any>) => void);
          events: {
              clusterId?: ClusterId;
              endpointId?: EndpointNumber;
              eventId?: EventId;
              isUrgent?: boolean;
          }[];
          executeQueued?: boolean;
          isFabricFiltered?: boolean;
          keepSubscriptions?: boolean;
          maxIntervalCeilingSeconds: number;
          minIntervalFloorSeconds: number;
          updateReceived?: (() => void);
          updateTimeoutHandler?: Callback;
      }
      • OptionalattributeListener?: ((data: DecodedAttributeReportValue<any>, valueChanged?: boolean, oldValue?: any) => void)
          • (data, valueChanged?, oldValue?): void
          • Parameters

            Returns void

      • attributes: {
            attributeId?: AttributeId;
            clusterId?: ClusterId;
            endpointId?: EndpointNumber;
        }[]
      • OptionaldataVersionFilters?: {
            clusterId: ClusterId;
            dataVersion: number;
            endpointId: EndpointNumber;
        }[]
      • OptionalenrichCachedAttributeData?: boolean
      • OptionaleventFilters?: TypeFromFields<{
            eventMin: FieldType<number | bigint>;
            nodeId: OptionalFieldType<NodeId>;
        }>[]
      • OptionaleventListener?: ((data: DecodedEventReportValue<any>) => void)
      • events: {
            clusterId?: ClusterId;
            endpointId?: EndpointNumber;
            eventId?: EventId;
            isUrgent?: boolean;
        }[]
      • OptionalexecuteQueued?: boolean
      • OptionalisFabricFiltered?: boolean
      • OptionalkeepSubscriptions?: boolean
      • maxIntervalCeilingSeconds: number
      • minIntervalFloorSeconds: number
      • OptionalupdateReceived?: (() => void)
          • (): void
          • Returns void

      • OptionalupdateTimeoutHandler?: Callback

    Returns Promise<{
        attributeReports?: DecodedAttributeReportValue<any>[];
        eventReports?: DecodedEventReportValue<any>[];
    }>