ChatEmoteCountResult chat.emote-count-result@1

Generated at from openvibe-contracts v0.84.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/emote-count-result.v1.json

chat.emote-count-result@1: the answer of GET /internal/moderation/channels/:channelId/emote-count on OpenVibe.Chat (capability chat.moderation.read): { ok: true, count } — how many custom emotes a channel holds (the emotes rows with that channel as their owner), so a stream chat can tell an owner whether their uploads landed and show a mod panel a count without shipping every emote. Counts only, never the emotes themselves. A failure is { ok: false, error }.

Fields

This schema has no named fields.

Examples

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

Valid: error
{
  "ok": false,
  "error": "chat store unavailable"
}
Valid: many
{
  "ok": true,
  "count": 12
}
Rejected: no-count
{
  "ok": true
}

Validate

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