specs/messaging/message/get/v0_1/payload library

Classes

MessageMeta
Metadata of one stored message. Never carries the message body.
Payload
Messaging — Get Message — payload
Response
The success response to a messaging/message/get request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/message/get/0.1#response.

Extension Types

DeliveryState
queued: stored and not yet handed to the recipient. delivered: handed to the recipient (pickup or live stream) but not yet deleted by it — the recipient has not acknowledged it.
Queue
Which of an account's two queues. receive holds messages addressed to the account awaiting its pickup. send holds messages the account sent that are still held against it until their recipient deletes them — so a stalled recipient fills its senders' send queues.
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

payloadSchemaJson → const String
This specification's payload schema, as JSON text.
responsePayloadSchemaJson → const String
As payloadSchemaJson, for the success-response variant.
responseSpec → const SpecPolicy
The SPEC §7.2 policy for the success-response variant.
responseTypeUri → const String
The success-response form of typeUri (SPEC §4.4.1).
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.