Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:37 Constructorsconstructor new Interaction Client ( exchangeProvider , address , queue ? , nodeStore ? ) : InteractionClient Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:41 PropertiesReadonly
address Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:40 Accessorschannel Type get channelType( ) : ChannelType Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:283 channel Updated get channelUpdated( ) : Observable < [ void ] , void > Returns Observable < [ void ] , void > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:42 max Known Event Number get maxKnownEventNumber( ) : undefined | EventNumber Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:296 session get session( ) : Session Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:282 Methodsclose close ( ) : void Returns void Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:281 get All Attributes get All Attributes ( options ? ) : Promise < DecodedAttributeReportValue < any > [] > Parameters Optional
options : { dataVersionFilters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] ; enrichCachedAttributeData ?: boolean ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
data Version Filters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Optional
enrich Cached Attribute Data ?: boolean Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:45 get All Attributes And Events get All Attributes And Events ( options ? ) : Promise < { attributeReports : DecodedAttributeReportValue < any > [] ; eventReports : DecodedEventReportValue < any > [] ; } > Parameters Optional
options : { dataVersionFilters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] ; enrichCachedAttributeData ?: boolean ; eventFilters ?: TypeFromFields < { eventMin : FieldType < number | bigint > ; nodeId : OptionalFieldType < NodeId > ; } > [] ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
data Version Filters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Optional
enrich Cached Attribute Data ?: boolean Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:60 get All Events get All Events ( options ? ) : Promise < DecodedEventReportValue < any > [] > Parameters Optional
options : { eventFilters ?: TypeFromFields < { eventMin : FieldType < number | bigint > ; nodeId : OptionalFieldType < NodeId > ; } > [] ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:55 get Attribute get Attribute < A > ( options ) : Promise < undefined | AttributeJsType < A > > Parameters options : { alwaysRequestFromRemote ?: boolean ; attribute : A ; clusterId : ClusterId ; endpointId : EndpointNumber ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
always Request From Remote ?: boolean attribute : A Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:123 get Attribute With Version get Attribute With Version < A > ( options ) : Promise < undefined | { value : AttributeJsType < A > ; version : number ; } > Parameters options : { alwaysRequestFromRemote ?: boolean ; attribute : A ; clusterId : ClusterId ; endpointId : EndpointNumber ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
always Request From Remote ?: boolean attribute : A Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Returns Promise < undefined | { value : AttributeJsType < A > ; version : number ; } > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:131 get Cached Cluster Data Versions get Cached Cluster Data Versions ( filter ? ) : { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Returns { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:288 get Event get Event < T , E > ( options ) : Promise < undefined | DecodedEventData < T > [] > Parameters options : { clusterId : ClusterId ; endpointId : EndpointNumber ; event : E ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; minimumEventNumber ?: EventNumber ; } event : E Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Optional
minimum Event Number ?: EventNumber Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:142 get Multiple Attributes get Multiple Attributes ( options ? ) : Promise < DecodedAttributeReportValue < any > [] > Parameters Optional
options : { attributes ?: { attributeId ?: AttributeId ; clusterId ?: ClusterId ; endpointId ?: EndpointNumber ; } [] ; dataVersionFilters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] ; enrichCachedAttributeData ?: boolean ; executeQueued ?: boolean ; isFabricFiltered ?: boolean ; } Optional
attributes ?: { attributeId ?: AttributeId ; clusterId ?: ClusterId ; endpointId ?: EndpointNumber ; } [] Optional
data Version Filters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Optional
enrich Cached Attribute Data ?: boolean Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:74 get Multiple Attributes And Events get Multiple Events get Multiple Events ( options ? ) : Promise < DecodedEventReportValue < any > [] > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:89 invoke invoke < C > ( options ) : Promise < ResponseType < C > > Parameters options : { asTimedRequest ?: boolean ; clusterId : ClusterId ; command : C ; endpointId : EndpointNumber ; executeQueued ?: boolean ; request : RequestType < C > ; timedRequestTimeoutMs ?: number ; useExtendedFailSafeMessageResponseTimeout ?: boolean ; } Optional
as Timed Request ?: boolean command : C Optional
execute Queued ?: boolean Optional
timed Request Timeout Ms ?: number Optional
use Extended Fail Safe Message Response Timeout ?: boolean Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:259 invoke With Suppressed Response invoke With Suppressed Response < C > ( options ) : Promise < void > Parameters options : { asTimedRequest ?: boolean ; clusterId : ClusterId ; command : C ; endpointId : EndpointNumber ; executeQueued ?: boolean ; request : RequestType < C > ; timedRequestTimeoutMs ?: number ; } Optional
as Timed Request ?: boolean command : C Optional
execute Queued ?: boolean Optional
timed Request Timeout Ms ?: number Returns Promise < void > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:269 register Subscription Listener register Subscription Listener ( subscriptionId , listener ) : void Returns void Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:43 remove All Subscriptions remove All Subscriptions ( ) : void Returns void Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:280 remove Subscription remove Subscription ( subscriptionId ) : void Returns void Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:44 set Attribute set Attribute < T > ( options ) : Promise < void > Parameters options : { asTimedRequest ?: boolean ; attributeData : { attribute : Attribute < T , any > ; clusterId : ClusterId ; dataVersion ?: number ; endpointId : EndpointNumber ; value : T ; } ; executeQueued ?: boolean ; suppressResponse ?: boolean ; timedRequestTimeoutMs ?: number ; } Optional
as Timed Request ?: boolean attribute Data : { attribute : Attribute < T , any > ; clusterId : ClusterId ; dataVersion ?: number ; endpointId : EndpointNumber ; value : T ; } Optional
data Version ?: number value : T Optional
execute Queued ?: boolean Optional
suppress Response ?: boolean Optional
timed Request Timeout Ms ?: number Returns Promise < void > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:151 set Multiple Attributes set Multiple Attributes ( options ) : Promise < AttributeStatus [] > Parameters options : { asTimedRequest ?: boolean ; attributes : { attribute : Attribute < any , any > ; clusterId : ClusterId ; dataVersion ?: number ; endpointId : EndpointNumber ; value : any ; } [] ; executeQueued ?: boolean ; suppressResponse ?: boolean ; timedRequestTimeoutMs ?: number ; } Optional
as Timed Request ?: boolean attributes : { attribute : Attribute < any , any > ; clusterId : ClusterId ; dataVersion ?: number ; endpointId : EndpointNumber ; value : any ; } [] Optional
execute Queued ?: boolean Optional
suppress Response ?: boolean Optional
timed Request Timeout Ms ?: number Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:164 subscribe All Attributes And Events subscribe All Attributes And Events ( options ) : Promise < { attributeReports ?: DecodedAttributeReportValue < any > [] ; eventReports ?: DecodedEventReportValue < any > [] ; } > 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 ; } Optional
attribute Listener ?: ( ( data : DecodedAttributeReportValue < any > , valueChanged ?: boolean , oldValue ?: unknown ) => void ) ( data , valueChanged ? , oldValue ? ) : void Returns void Optional
data Version Filters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Optional
enrich Cached Attribute Data ?: boolean Optional
event Listener ?: ( ( data : DecodedEventReportValue < any > ) => void ) Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Optional
is Urgent ?: boolean Optional
keep Subscriptions ?: boolean max Interval Ceiling Seconds : number min Interval Floor Seconds : number Optional
update Received ?: ( ( ) => void ) Optional
update Timeout Handler ?: Callback Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:205 subscribe Attribute subscribe Attribute < A > ( options ) : Promise < void > 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 Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Optional
keep Subscriptions ?: boolean Optional
known Data Version ?: number Optional
listener ?: ( ( value : AttributeJsType < A > , version : number ) => void ) ( value , version ) : void Returns void max Interval Ceiling Seconds : number min Interval Floor Seconds : number Optional
update Received ?: ( ( ) => void ) Optional
update Timeout Handler ?: Callback Returns Promise < void > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:177 subscribe Event subscribe Event < T , E > ( options ) : Promise < void > 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 ; } event : E Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Optional
is Urgent ?: boolean Optional
listener ?: ( ( value : DecodedEventData < T > ) => void ) ( value ) : void Returns void max Interval Ceiling Seconds : number Optional
minimum Event Number ?: EventNumber min Interval Floor Seconds : number Optional
update Received ?: ( ( ) => void ) Optional
update Timeout Handler ?: Callback Returns Promise < void > Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:191 subscribe Multiple Attributes And Events subscribe Multiple Attributes And Events ( options ) : Promise < { attributeReports ?: DecodedAttributeReportValue < any > [] ; eventReports ?: DecodedEventReportValue < any > [] ; } > 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 ; } Optional
attribute Listener ?: ( ( data : DecodedAttributeReportValue < any > , valueChanged ?: boolean , oldValue ?: any ) => void ) ( data , valueChanged ? , oldValue ? ) : void Returns void Optional
data Version Filters ?: { clusterId : ClusterId ; dataVersion : number ; endpointId : EndpointNumber ; } [] Optional
enrich Cached Attribute Data ?: boolean Optional
event Listener ?: ( ( data : DecodedEventReportValue < any > ) => void ) events : { clusterId ?: ClusterId ; endpointId ?: EndpointNumber ; eventId ?: EventId ; isUrgent ?: boolean ; } [] Optional
execute Queued ?: boolean Optional
is Fabric Filtered ?: boolean Optional
keep Subscriptions ?: boolean max Interval Ceiling Seconds : number min Interval Floor Seconds : number Optional
update Received ?: ( ( ) => void ) Optional
update Timeout Handler ?: Callback Defined in packages/protocol/dist/esm/interaction/InteractionClient.d.ts:227
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.