TipsOverlayDeliveredPayload tips.overlay.delivered@1

Generated at from openvibe-contracts v0.33.0 and openvibe-sdk v0.5.0.

Version
1.0.0
Owner
tips
Visibility
first-party
Status
active
Compatibility
backward
Decision
ADR-012
Schema
https://openvibe.network/contracts/events/payloads/tips.overlay.delivered.v1.json

tips.overlay.delivered v1 (OpenVibe.Tips server/domain/overlays.js markDelivered). An overlay delivery (alert or goal update) reached at least one connected overlay, first time only. Envelope: subject { type: overlay_delivery, id: tovd_… }, visibility internal, priority important, actor service:tips. Never for tests.

Fields

FieldTypeRequiredDescriptionConstraints
delivery_idstringyes
  • pattern ^tovd_[0-9A-HJKMNP-TV-Z]{26}$
creatoridentity.subject-refyes
kindenumyes
  • one of "alert", "goal"
interaction_idstring | nullyes
goal_idstring | nullyes

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: alert
{
  "delivery_id": "tovd_01JAB3C4D5E6F7G8H9J0K1MNPT",
  "creator": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "kind": "alert",
  "interaction_id": "tint_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "goal_id": null
}
Rejected: bad-kind
{
  "delivery_id": "tovd_01JAB3C4D5E6F7G8H9J0K1MNPT",
  "creator": {
    "type": "user",
    "id": "usr_01JAB2C3D4E5F6G7H8J9K0MNPQ"
  },
  "kind": "sound",
  "interaction_id": "tint_01JAB3C4D5E6F7G8H9J0K1MNPQ",
  "goal_id": null
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('tips.overlay.delivered@1', value);   // { valid, errors: [{ path, message }] }