live.streamface.bot.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.

moderation array of ref #moderationRule Optional

No description available.

maxLength: 200 items
roles ref #roles Optional

No description available.

routines array of ref #routine Optional

No description available.

maxLength: 50 items
rules array of ref #rule Required

No description available.

maxLength: 50 items
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"
      },
      "moderation": {
        "items": {
          "ref": "#moderationRule",
          "type": "ref"
        },
        "maxLength": 200,
        "type": "array"
      },
      "roles": {
        "ref": "#roles",
        "type": "ref"
      },
      "routines": {
        "items": {
          "ref": "#routine",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "rules": {
        "items": {
          "ref": "#rule",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "enabled",
      "rules",
      "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"
}
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).

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",
      "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.

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"
    },
    "moderators": {
      "type": "boolean"
    },
    "mutuals": {
      "type": "boolean"
    },
    "users": {
      "items": {
        "ref": "#allowedUser",
        "type": "ref"
      },
      "maxLength": 200,
      "type": "array"
    }
  },
  "required": [
    "followers",
    "mutuals",
    "moderators",
    "users"
  ],
  "type": "object"
}
routine object

No description available.

Properties

enabled boolean Required

No description available.

id string Required

No description available.

maxLength: 64 bytes
intervalMilliseconds integer Required

No description available.

minimum: 30000maximum: 86400000
response string Required

No description available.

maxLength: 250 bytes
View raw schema 
{
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "maxLength": 64,
      "type": "string"
    },
    "intervalMilliseconds": {
      "maximum": 86400000,
      "minimum": 30000,
      "type": "integer"
    },
    "response": {
      "maxLength": 250,
      "type": "string"
    }
  },
  "required": [
    "id",
    "enabled",
    "response",
    "intervalMilliseconds"
  ],
  "type": "object"
}
rule object

No description available.

Properties

command string Required

No description available.

maxLength: 40 bytes
cooldownMilliseconds integer Required

No description available.

minimum: 5000maximum: 86400000
response string Required

No description available.

maxLength: 250 bytes
View raw schema 
{
  "properties": {
    "command": {
      "maxLength": 40,
      "type": "string"
    },
    "cooldownMilliseconds": {
      "maximum": 86400000,
      "minimum": 5000,
      "type": "integer"
    },
    "response": {
      "maxLength": 250,
      "type": "string"
    }
  },
  "required": [
    "command",
    "response",
    "cooldownMilliseconds"
  ],
  "type": "object"
}

Lexicon Garden

@