# live.streamface.bot.settings

> Published by [streamface.live](https://lexicon.garden/identity/did:plc:j66wyknizjxecbnrenjzj7l3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.bot.settings)
- [Documentation](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.bot.settings/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.bot.settings/examples)

## Definitions

### `live.streamface.bot.settings#allowedUser`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `handle` | `string` | No |  |

### `live.streamface.bot.settings`

**Type**: `record`

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `enabled` | `boolean` | Yes |  |
| `moderation` | `array` | No |  |
| `roles` | `ref` → `#roles` | No |  |
| `routines` | `array` | No |  |
| `rules` | `array` | Yes |  |
| `updatedAt` | `string` (datetime) | Yes |  |

### `live.streamface.bot.settings#moderationRule`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `blocked` | `boolean` | Yes |  |
| `cooldownMilliseconds` | `integer` | Yes |  |
| `did` | `string` (did) | Yes |  |
| `handle` | `string` | No |  |

### `live.streamface.bot.settings#roles`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `followers` | `boolean` | Yes |  |
| `moderators` | `boolean` | Yes |  |
| `mutuals` | `boolean` | Yes |  |
| `users` | `array` | Yes |  |

### `live.streamface.bot.settings#routine`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `enabled` | `boolean` | Yes |  |
| `id` | `string` | Yes |  |
| `intervalMilliseconds` | `integer` | Yes |  |
| `response` | `string` | Yes |  |

### `live.streamface.bot.settings#rule`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `command` | `string` | Yes |  |
| `cooldownMilliseconds` | `integer` | Yes |  |
| `response` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "allowedUser": {
      "properties": {
        "did": {
          "format": "did",
          "maxLength": 2048,
          "type": "string"
        },
        "handle": {
          "maxLength": 253,
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    },
    "main": {
      "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"
    },
    "moderationRule": {
      "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": {
      "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": {
      "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": {
      "properties": {
        "command": {
          "maxLength": 40,
          "type": "string"
        },
        "cooldownMilliseconds": {
          "maximum": 86400000,
          "minimum": 5000,
          "type": "integer"
        },
        "response": {
          "maxLength": 250,
          "type": "string"
        }
      },
      "required": [
        "command",
        "response",
        "cooldownMilliseconds"
      ],
      "type": "object"
    }
  },
  "id": "live.streamface.bot.settings",
  "lexicon": 1
}
```