# live.streamface.emoticons.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.emoticons.settings)
- [Documentation](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.emoticons.settings/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:j66wyknizjxecbnrenjzj7l3/live.streamface.emoticons.settings/examples)

## Definitions

### `live.streamface.emoticons.settings#allowedUser`

**Type**: `object`

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

### `live.streamface.emoticons.settings#eventMapping`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `commandId` | `string` | Yes |  |
| `event` | `string` | Yes |  |
| `text` | `string` | No | Optional overlay text beneath the event clip. |

### `live.streamface.emoticons.settings`

**Type**: `record`

**Key**: `literal:self`

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

### `live.streamface.emoticons.settings#moderationRule`

**Type**: `object`

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

### `live.streamface.emoticons.settings#roles`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `followers` | `boolean` | Yes |  |
| `following` | `boolean` | No | Allow accounts followed by the streamer. |
| `moderators` | `boolean` | Yes |  |
| `mutuals` | `boolean` | Yes |  |
| `users` | `array` | 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"
    },
    "eventMapping": {
      "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"
    },
    "main": {
      "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"
    },
    "moderationRule": {
      "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": {
      "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"
    }
  },
  "id": "live.streamface.emoticons.settings",
  "lexicon": 1
}
```