Skip to content
Developer Preview

PeerInboxItemDrainedParams

Experimental

peer/inboxItemDrained params: one peer inbox drain — a consumption marker with its recorded stamp. The member set mirrors MonitorInboxItemDrainedParams so the client fold is the monitor arm’s twin.

  • deliveryVisible — Experimental
  • drainTargetRunStream — Experimental
  • drainedAt — Experimental
  • itemId — Experimental
  • sessionId — Experimental
  • sourceRange — Experimental
  • viewCursor — Experimental
Source

schema/msp/experimental/msp.schema.json#/types/PeerInboxItemDrainedParams

{
"description": "`peer/inboxItemDrained` params: one peer inbox\ndrain — a consumption marker with its recorded stamp. The member\nset mirrors `MonitorInboxItemDrainedParams` so the\nclient fold is the monitor arm's twin.",
"properties": {
"deliveryVisible": {
"description": "False is a local claim-only recall: no delivery row or recovery\nconsequence, but the drain still stamps the awaiting verdict.",
"type": "boolean"
},
"drainTargetRunStream": {
"$ref": "#/$defs/StreamRef",
"description": "The draining run stream (`StreamRef`), absent means the current\ndraining run."
},
"drainedAt": {
"description": "The drain record's recorded stamp (RFC3339).",
"type": "string"
},
"itemId": {
"description": "The drained inbox item id.",
"type": "string"
},
"sessionId": {
"description": "The owning session.",
"type": "string"
},
"sourceRange": {
"$ref": "#/$defs/SourceRange",
"description": "The durable records this event folded from."
},
"viewCursor": {
"description": "Opaque, strictly monotonic view cursor.",
"type": "string"
}
},
"required": [
"deliveryVisible",
"drainedAt",
"itemId",
"sessionId",
"sourceRange",
"viewCursor"
],
"type": "object",
"x-msp-descriptor": "peer/inboxItemDrained",
"x-msp-stability": "experimental"
}