ShareListResult share.list-result@1

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

Version
1.0.0
Owner
network
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/share/list-result.v1.json

share.list-result@1: network-wide sharing. Ids only; no resource title or content. Members apply to people audience; pending recipients may preview for seven days.

Fields

FieldTypeRequiredDescriptionConstraints
itemsarray of objectyes
  • items: no other fields
items[].refshare.resource-refyes
items[].owner_subjectidentity.subject-refyes
items[].audienceenumyes
  • one of "public", "link", "people", "private"
items[].roleenumyes
  • one of "viewer", "editor"
items[].shared_atstringyes
  • format date-time
items[].transfershare.transfer
next_cursorstring | nullyes

Examples

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

Valid: example
{
  "items": [],
  "next_cursor": null
}
Rejected: unknown-field
{
  "items": [],
  "next_cursor": null,
  "title": "must never appear"
}

Validate

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