ChatDmBlockStateResult chat.dm-block-state-result@1
Generated at from
openvibe-contracts v0.107.0 and
openvibe-sdk v0.26.0.
- Version
- 1.0.0
- Owner
- chat
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/chat/dm-block-state-result.v1.json
chat.dm-block-state-result@1: the answer of GET /internal/chat/dm/block-state?a&b on OpenVibe.Chat (capability chat.messages.read): blocked is true when either user has blocked the other, in Chat's dm_blocks or as a Network platform block (dm.js isBlockedEither, the check the DM and call routes use). a and b are positive Live user ids and must differ; OpenVibe.Live asks this before sending a call invite. A failure is chat.ingress-ack@1's error.
Fields
This schema has no named fields.
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: blocked
{
"ok": true,
"blocked": true
}Rejected: missing-blocked
{
"ok": true
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('chat.dm-block-state-result@1', value); // { valid, errors: [{ path, message }] }