Preparing search index...
The search index is not available
matter.js-monorepo
matter.js-monorepo
@matter/protocol
ServerSubscriptionContext
Interface ServerSubscriptionContext
Interface between
ServerSubscription
and the local Matter environment.
interface
ServerSubscriptionContext
{
session
:
SecureSession
;
structure
:
InteractionEndpointStructure
;
initiateExchange
(
address
:
PeerAddress
,
protocolId
:
number
)
:
MessageExchange
;
readAttribute
(
path
:
AttributePath
,
attribute
:
AnyAttributeServer
<
unknown
>
,
offline
?:
boolean
)
:
Promise
<
{
value
:
unknown
;
version
:
number
;
}
>
;
readEvent
(
path
:
EventPath
,
event
:
AnyEventServer
<
any
,
any
>
,
eventFilters
:
undefined
|
TypeFromFields
<
{
eventMin
:
FieldType
<
number
|
bigint
>
;
nodeId
:
OptionalFieldType
<
NodeId
>
;
}
>
[]
)
:
Promise
<
EventStorageData
<
unknown
>
[]
>
;
}
Index
Properties
session
structure
Methods
initiate
Exchange
read
Attribute
read
Event
Properties
session
session
:
SecureSession
structure
structure
:
InteractionEndpointStructure
Methods
initiate
Exchange
initiate
Exchange
(
address
,
protocolId
)
:
MessageExchange
Parameters
address
:
PeerAddress
protocolId
:
number
Returns
MessageExchange
read
Attribute
read
Attribute
(
path
,
attribute
,
offline
?
)
:
Promise
<
{
value
:
unknown
;
version
:
number
;
}
>
Parameters
path
:
AttributePath
attribute
:
AnyAttributeServer
<
unknown
>
Optional
offline
:
boolean
Returns
Promise
<
{
value
:
unknown
;
version
:
number
;
}
>
read
Event
read
Event
(
path
,
event
,
eventFilters
)
:
Promise
<
EventStorageData
<
unknown
>
[]
>
Parameters
path
:
EventPath
event
:
AnyEventServer
<
any
,
any
>
eventFilters
:
undefined
|
TypeFromFields
<
{
eventMin
:
FieldType
<
number
|
bigint
>
;
nodeId
:
OptionalFieldType
<
NodeId
>
;
}
>
[]
Returns
Promise
<
EventStorageData
<
unknown
>
[]
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
session
structure
Methods
initiate
Exchange
read
Attribute
read
Event
matter.js-monorepo
Loading...
Interface between ServerSubscription and the local Matter environment.