specs/messaging/monitor/event/v0_2/payload
library
Classes
-
MonitorEvent
-
One observed step in the life of one message at the mediator. Carries metadata only
— never a message body.
-
Payload
-
Messaging — Traffic Monitor Event — payload
-
TrafficOutcome
-
Why a frame was refused or failed.
Extension Types
-
TrafficChannel
-
How the traffic reached or left the mediator.
peerMediator is
mediator-to-mediator forwarding.
-
TrafficDirection
-
inbound: arriving at the mediator. outbound: leaving it (delivery to a
recipient, or a forward to another mediator). internal: a state change with no
wire traffic (expiry, deletion, purge).
-
TrafficStage
-
What happened.
received: a frame arrived. stored: it was queued for a local
account. delivered: handed to its recipient. forwarded: relayed to another
mediator. refused: rejected (see the event's outcome). deleted: removed by
its recipient or an administrator. expired: removed by expiry. purged: removed
by a queue purge.
-
WireProtocol
-
The protocol a message travelled in, as the mediator detected it from the wire
form.
didcomm is DIDComm v2 (JWE/JWS); didcommV1 is a DIDComm v1 envelope;
tsp is a Trust Spanning Protocol message; other is anything the mediator could
not classify.
Constants
-
deprecation
→ const String?
-
Why this specification version is deprecated, or null when it is current.
-
extendsVersion
→ const String?
-
The
MAJOR.MINOR this version declares it extends (SPEC §5.2, "Declared
extension"), or null when it declares none.
-
payloadSchemaJson
→ const String
-
This specification's payload schema, as JSON text.
-
spec
→ const SpecPolicy
-
The SPEC §7.2 policy for the request variant, taken from this
specification's front matter.
-
typeUri
→ const String
-
The Trust Task type URI this library's Payload is carried under.
Typedefs
-
Ext
= Map<String, dynamic>
-
Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a
reverse-DNS namespace; structure under each namespace is opaque to the framework.
-
Vid
= String
-
A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the
account's controlling DID, carried verbatim and compared by exact string equality.
For privacy — and because some mediators key accounts by a one-way hash and never
hold the full DID — a stable hash of the DID (e.g. its SHA-256 digest) is an
equally valid value here: producer and consumer simply agree on the same opaque
identifier and compare by exact string equality. The field carries whichever form
the issuing mediator uses.