BotWatchLinkResult bot.watch-link-result@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
bot
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/bot/watch-link-result.v1.json

bot.watch-link-result@1: the watch link itself (plan L55): the page that shows the desk, and when it ends. The link is the machine owner's own, so the page needs no sign-in.

Fields

FieldTypeRequiredDescriptionConstraints
urlstringyesThe page that shows the desk: https://openvibe.bot/screen/<token>.
  • format uri
expires_atstringyesWhen the link ends.
  • format date-time
deskstringThe desk the link shows.
controlbooleantrue: the holders may use the mouse and keyboard too.
share_idstringBot's id for the link.

Examples

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

Valid: link
{
  "url": "https://openvibe.bot/screen/abcdefghijklmnopqrstuvwxyz0123456789ABCDEFGH",
  "expires_at": "2026-11-01T12:30:00.000Z",
  "desk": "desk-task-a",
  "control": false,
  "share_id": "shr_01JAB2C3D4E5F6G7H8J9K0MNPS"
}
Rejected: missing-url
{
  "expires_at": "2026-11-01T12:30:00.000Z"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('bot.watch-link-result@1', value);   // { valid, errors: [{ path, message }] }