MediaAvatarReleaseResult media.avatar-release-result@1
Generated at from
openvibe-contracts v0.419.0 and
openvibe-sdk v0.161.0.
- Version
- 1.0.0
- Owner
- media
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/media/avatar-release-result.v1.json
media.avatar-release-result@1: the answer of POST /internal/avatar-release on OpenVibe.Media: { ok: true, released }, how many active references were released (0 when there were none: releasing twice is not an error).
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
ok | const | yes |
| |
released | integer | yes |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: released
{
"ok": true,
"released": 1
}Rejected: negative
{
"ok": true,
"released": -1
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('media.avatar-release-result@1', value); // { valid, errors: [{ path, message }] }