# social.colibri.actor.defs

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.defs/examples)

## Definitions

### `social.colibri.actor.defs#actorData`

**Type**: `object`

The profile and presence data for a Colibri actor.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `isBot` | `boolean` | Yes |  |
| `theme` | `ref` → `lex:social.colibri.actor.defs#profileTheme` | No |  |
| `avatar` | `blob` | No |  |
| `banner` | `blob` | No |  |
| `status` | `ref` → `lex:social.colibri.actor.defs#actorStatus` | Yes |  |
| `description` | `string` | No |  |
| `displayName` | `string` | Yes |  |
| `onlineState` | `string` | Yes |  |
| `syncBluesky` | `boolean` | Yes |  |
| `preferredBadge` | `string` | No |  |

### `social.colibri.actor.defs#actorView`

**Type**: `object`

A hydrated Colibri actor: identity plus profile data.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `data` | `ref` → `lex:social.colibri.actor.defs#actorData` | Yes |  |
| `handle` | `string` (handle) | Yes |  |

### `social.colibri.actor.defs#actorStatus`

**Type**: `object`

A user's Colibri status line.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `text` | `string` | Yes |  |
| `emoji` | `string` | No |  |

### `social.colibri.actor.defs#profileTheme`

**Type**: `object`

Colibri-only profile theming.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `gradient` | `ref` → `lex:social.colibri.actor.defs#profileGradient` | No |  |
| `accentColor` | `string` | No |  |
| `bannerColor` | `string` | No |  |

### `social.colibri.actor.defs#profileGradient`

**Type**: `object`

Two-color gradient profile theme.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `primary` | `string` | No |  |
| `secondary` | `string` | No |  |

## Raw Schema

```json
{
  "id": "social.colibri.actor.defs",
  "defs": {
    "actorData": {
      "type": "object",
      "required": [
        "displayName",
        "isBot",
        "onlineState",
        "syncBluesky",
        "status"
      ],
      "properties": {
        "isBot": {
          "type": "boolean"
        },
        "theme": {
          "ref": "lex:social.colibri.actor.defs#profileTheme",
          "type": "ref"
        },
        "avatar": {
          "type": "blob"
        },
        "banner": {
          "type": "blob"
        },
        "status": {
          "ref": "lex:social.colibri.actor.defs#actorStatus",
          "type": "ref"
        },
        "description": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "onlineState": {
          "type": "string",
          "knownValues": [
            "online",
            "away",
            "dnd",
            "offline"
          ]
        },
        "syncBluesky": {
          "type": "boolean"
        },
        "preferredBadge": {
          "type": "string"
        }
      },
      "description": "The profile and presence data for a Colibri actor."
    },
    "actorView": {
      "type": "object",
      "required": [
        "did",
        "handle",
        "data"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "data": {
          "ref": "lex:social.colibri.actor.defs#actorData",
          "type": "ref"
        },
        "handle": {
          "type": "string",
          "format": "handle"
        }
      },
      "description": "A hydrated Colibri actor: identity plus profile data."
    },
    "actorStatus": {
      "type": "object",
      "required": [
        "text"
      ],
      "properties": {
        "text": {
          "type": "string"
        },
        "emoji": {
          "type": "string"
        }
      },
      "description": "A user's Colibri status line."
    },
    "profileTheme": {
      "type": "object",
      "properties": {
        "gradient": {
          "ref": "lex:social.colibri.actor.defs#profileGradient",
          "type": "ref"
        },
        "accentColor": {
          "type": "string"
        },
        "bannerColor": {
          "type": "string"
        }
      },
      "description": "Colibri-only profile theming."
    },
    "profileGradient": {
      "type": "object",
      "properties": {
        "primary": {
          "type": "string"
        },
        "secondary": {
          "type": "string"
        }
      },
      "description": "Two-color gradient profile theme."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```