PeerSettlementOutcome

Experimental

What one released message shows on the receiver timeline. A flat object rather than a tagged union so the experimental gate can key every member.

Fields and variants

• body — Experimental
• decisionId — Experimental
• displayContext — Experimental
• itemId — Experimental
• kind — Experimental
• messageId — Experimental
• origin — Experimental
• senderLabel — Experimental
• senderSessionId — Experimental
• settledAtUs — Experimental

Source

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

{
  "description": "What one released message shows on the receiver timeline. A flat object\nrather than a tagged union so the experimental gate can key every member.",
  "properties": {
    "body": {
      "type": "string"
    },
    "decisionId": {
      "description": "The releasing decision; present exactly when `kind` is `allow_once`.",
      "type": "string"
    },
    "displayContext": {
      "$ref": "#/$defs/PeerMessageDisplayContext",
      "description": "The connector's presentation facts on a forwarded message; only on\n`normal`."
    },
    "itemId": {
      "type": "string"
    },
    "kind": {
      "$ref": "#/$defs/PeerSettlementOutcomeKind",
      "description": "The outcome kind (required)."
    },
    "messageId": {
      "type": "string"
    },
    "origin": {
      "$ref": "#/$defs/PeerSettlementOrigin"
    },
    "senderLabel": {
      "type": "string"
    },
    "senderSessionId": {
      "type": "string"
    },
    "settledAtUs": {
      "description": "The settlement instant in Unix microseconds; present exactly when\n`kind` is `normal`.",
      "type": "integer"
    }
  },
  "required": [
    "body",
    "itemId",
    "kind",
    "messageId",
    "origin",
    "senderLabel"
  ],
  "type": "object",
  "x-msp-descriptor": "peer/settlements",
  "x-msp-stability": "experimental"
}