Preparing search index...
The search index is not available
matter.js-monorepo
matter.js-monorepo
@matter/protocol
SubscriptionClient
Class SubscriptionClient
Implements
ProtocolHandler
Index
Constructors
constructor
Methods
close
get
Id
on
New
Exchange
register
Subscription
Listener
register
Subscription
Update
Timer
remove
Subscription
Listener
remove
Subscription
Update
Timer
Constructors
constructor
new
Subscription
Client
(
)
:
SubscriptionClient
Returns
SubscriptionClient
Methods
close
close
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Id
get
Id
(
)
:
number
Returns
number
on
New
Exchange
on
New
Exchange
(
exchange
)
:
Promise
<
void
>
Parameters
exchange
:
MessageExchange
Returns
Promise
<
void
>
register
Subscription
Listener
register
Subscription
Listener
(
subscriptionId
,
listener
)
:
void
Parameters
subscriptionId
:
number
listener
:
(
(
dataReport
:
TypeFromFields
<
{
attributeReports
:
OptionalFieldType
<
TypeFromFields
<
{
attributeData
:
OptionalFieldType
<
TypeFromFields
<
{
data
:
FieldType
<
(
...
)
>
;
dataVersion
:
OptionalFieldType
<
(
...
)
>
;
path
:
FieldType
<
(
...
)
>
;
}
>
>
;
attributeStatus
:
OptionalFieldType
<
TypeFromFields
<
{
path
:
FieldType
<
(
...
)
>
;
status
:
FieldType
<
(
...
)
>
;
}
>
>
;
}
>
[]
>
;
eventReports
:
OptionalFieldType
<
TypeFromFields
<
{
eventData
:
OptionalFieldType
<
TypeFromFields
<
{
data
:
OptionalFieldType
<
(
...
)
>
;
deltaEpochTimestamp
:
OptionalFieldType
<
(
...
)
>
;
deltaSystemTimestamp
:
OptionalFieldType
<
(
...
)
>
;
epochTimestamp
:
OptionalFieldType
<
(
...
)
>
;
eventNumber
:
FieldType
<
(
...
)
>
;
path
:
FieldType
<
(
...
)
>
;
priority
:
FieldType
<
(
...
)
>
;
systemTimestamp
:
OptionalFieldType
<
(
...
)
>
;
}
>
>
;
eventStatus
:
OptionalFieldType
<
TypeFromFields
<
{
path
:
FieldType
<
(
...
)
>
;
status
:
FieldType
<
(
...
)
>
;
}
>
>
;
}
>
[]
>
;
interactionModelRevision
:
FieldType
<
number
>
;
moreChunkedMessages
:
OptionalFieldType
<
boolean
>
;
subscriptionId
:
OptionalFieldType
<
number
>
;
suppressResponse
:
OptionalFieldType
<
boolean
>
;
}
>
)
=>
MaybePromise
<
void
>
)
(
dataReport
)
:
MaybePromise
<
void
>
Parameters
dataReport
:
TypeFromFields
<
{
attributeReports
:
OptionalFieldType
<
TypeFromFields
<
{
attributeData
:
OptionalFieldType
<
TypeFromFields
<
{
data
:
FieldType
<
(
...
)
>
;
dataVersion
:
OptionalFieldType
<
(
...
)
>
;
path
:
FieldType
<
(
...
)
>
;
}
>
>
;
attributeStatus
:
OptionalFieldType
<
TypeFromFields
<
{
path
:
FieldType
<
(
...
)
>
;
status
:
FieldType
<
(
...
)
>
;
}
>
>
;
}
>
[]
>
;
eventReports
:
OptionalFieldType
<
TypeFromFields
<
{
eventData
:
OptionalFieldType
<
TypeFromFields
<
{
data
:
OptionalFieldType
<
(
...
)
>
;
deltaEpochTimestamp
:
OptionalFieldType
<
(
...
)
>
;
deltaSystemTimestamp
:
OptionalFieldType
<
(
...
)
>
;
epochTimestamp
:
OptionalFieldType
<
(
...
)
>
;
eventNumber
:
FieldType
<
(
...
)
>
;
path
:
FieldType
<
(
...
)
>
;
priority
:
FieldType
<
(
...
)
>
;
systemTimestamp
:
OptionalFieldType
<
(
...
)
>
;
}
>
>
;
eventStatus
:
OptionalFieldType
<
TypeFromFields
<
{
path
:
FieldType
<
(
...
)
>
;
status
:
FieldType
<
(
...
)
>
;
}
>
>
;
}
>
[]
>
;
interactionModelRevision
:
FieldType
<
number
>
;
moreChunkedMessages
:
OptionalFieldType
<
boolean
>
;
subscriptionId
:
OptionalFieldType
<
number
>
;
suppressResponse
:
OptionalFieldType
<
boolean
>
;
}
>
Returns
MaybePromise
<
void
>
Returns
void
register
Subscription
Update
Timer
register
Subscription
Update
Timer
(
subscriptionId
,
timer
)
:
void
Parameters
subscriptionId
:
number
timer
:
Timer
Returns
void
remove
Subscription
Listener
remove
Subscription
Listener
(
subscriptionId
)
:
void
Parameters
subscriptionId
:
number
Returns
void
remove
Subscription
Update
Timer
remove
Subscription
Update
Timer
(
subscriptionId
)
:
void
Parameters
subscriptionId
:
number
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
close
get
Id
on
New
Exchange
register
Subscription
Listener
register
Subscription
Update
Timer
remove
Subscription
Listener
remove
Subscription
Update
Timer
matter.js-monorepo
Loading...