live.streamface.emoticons.settings

streamface.live

Documentation

main record

No description available.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

enabled boolean Required

No description available.

eventMappings array of ref #eventMapping Optional

No description available.

maxLength: 4 items
moderation array of ref #moderationRule Optional

No description available.

maxLength: 200 items
roles ref #roles Optional

No description available.

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "key": "literal:self",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "eventMappings": {
        "items": {
          "ref": "#eventMapping",
          "type": "ref"
        },
        "maxLength": 4,
        "type": "array"
      },
      "moderation": {
        "items": {
          "ref": "#moderationRule",
          "type": "ref"
        },
        "maxLength": 200,
        "type": "array"
      },
      "roles": {
        "ref": "#roles",
        "type": "ref"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "enabled",
      "createdAt",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}
allowedUser object

No description available.

Properties

did string did Required

A decentralized identifier (DID).

maxLength: 2048 bytes
handle string Optional

No description available.

maxLength: 253 bytes
View raw schema 
{
  "properties": {
    "did": {
      "format": "did",
      "maxLength": 2048,
      "type": "string"
    },
    "handle": {
      "maxLength": 253,
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}
eventMapping object

No description available.

Properties

commandId string Required

No description available.

maxLength: 512 bytes
event string Required

No description available.

text string Optional

Optional overlay text beneath the event clip.

maxLength: 2000 bytesmaxGraphemes: 500 graphemes
View raw schema 
{
  "properties": {
    "commandId": {
      "maxLength": 512,
      "type": "string"
    },
    "event": {
      "enum": [
        "teleport-arrival",
        "teleport-canceled",
        "stream-started",
        "stream-ended"
      ],
      "type": "string"
    },
    "text": {
      "description": "Optional overlay text beneath the event clip.",
      "maxGraphemes": 500,
      "maxLength": 2000,
      "type": "string"
    }
  },
  "required": [
    "event",
    "commandId"
  ],
  "type": "object"
}
moderationRule object

No description available.

Properties

blocked boolean Required

No description available.

cooldownMilliseconds integer Required

No description available.

minimum: 0maximum: 86400000
did string did Required

A decentralized identifier (DID).

maxLength: 2048 bytes
handle string Optional

No description available.

maxLength: 253 bytes
View raw schema 
{
  "properties": {
    "blocked": {
      "type": "boolean"
    },
    "cooldownMilliseconds": {
      "maximum": 86400000,
      "minimum": 0,
      "type": "integer"
    },
    "did": {
      "format": "did",
      "maxLength": 2048,
      "type": "string"
    },
    "handle": {
      "maxLength": 253,
      "type": "string"
    }
  },
  "required": [
    "did",
    "blocked",
    "cooldownMilliseconds"
  ],
  "type": "object"
}
roles object

No description available.

Properties

followers boolean Required

No description available.

following boolean Optional

Allow accounts followed by the streamer.

moderators boolean Required

No description available.

mutuals boolean Required

No description available.

users array of ref#allowedUser Required

No description available.

maxLength: 200 items
View raw schema 
{
  "properties": {
    "followers": {
      "type": "boolean"
    },
    "following": {
      "description": "Allow accounts followed by the streamer.",
      "type": "boolean"
    },
    "moderators": {
      "type": "boolean"
    },
    "mutuals": {
      "type": "boolean"
    },
    "users": {
      "items": {
        "ref": "#allowedUser",
        "type": "ref"
      },
      "maxLength": 200,
      "type": "array"
    }
  },
  "required": [
    "followers",
    "mutuals",
    "moderators",
    "users"
  ],
  "type": "object"
}

Lexicon Garden

@