# com.getorbyt.actor.defs

> Published by [getorbyt.com](https://lexicon.garden/identity/did:plc:2xrqztnmzlckb3xfuuukupso)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.actor.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.actor.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.actor.defs/examples)

## Definitions

### `com.getorbyt.actor.defs#profileView`

**Type**: `object`

An actor as Orbyt presents them. Orbyt profile fields win; anything absent is filled from the connected network's profile, which is also all an account that has never used Orbyt has.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `avatar` | `string` (uri) | No |  |
| `avatarVideo` | `string` (uri) | No |  |
| `banner` | `string` (uri) | No |  |
| `colors` | `ref` → `com.getorbyt.profile#colors` | No |  |
| `description` | `string` | No |  |
| `did` | `string` (did) | Yes |  |
| `displayName` | `string` | No |  |
| `followersCount` | `integer` | No |  |
| `followsCount` | `integer` | No |  |
| `handle` | `string` (handle) | No |  |
| `isBeta` | `boolean` | No | Joined during Orbyt's beta. Both apps badge it. |
| `isOrbytUser` | `boolean` | Yes | False for an account known only from the connected network, which clients badge as such. |
| `joinedAt` | `string` (datetime) | No |  |
| `showNetworkLink` | `boolean` | No |  |
| `viewer` | `ref` → `#viewerState` | No |  |

### `com.getorbyt.actor.defs#viewerState`

**Type**: `object`

The signed-in viewer's Orbyt relationship to this actor. Absent for anonymous reads.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `blocking` | `string` (at-uri) | No |  |
| `followedBy` | `string` (at-uri) | No |  |
| `following` | `string` (at-uri) | No | The viewer's com.getorbyt.graph.follow record for this actor. |
| `followingOnNetwork` | `boolean` | No | Whether the viewer follows this actor on the connected network, as of the viewer's last follow sync. Absent when unknown. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "profileView": {
      "description": "An actor as Orbyt presents them. Orbyt profile fields win; anything absent is filled from the connected network's profile, which is also all an account that has never used Orbyt has.",
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "avatarVideo": {
          "format": "uri",
          "type": "string"
        },
        "banner": {
          "format": "uri",
          "type": "string"
        },
        "colors": {
          "ref": "com.getorbyt.profile#colors",
          "type": "ref"
        },
        "description": {
          "maxGraphemes": 256,
          "maxLength": 2560,
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "followersCount": {
          "minimum": 0,
          "type": "integer"
        },
        "followsCount": {
          "minimum": 0,
          "type": "integer"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "isBeta": {
          "description": "Joined during Orbyt's beta. Both apps badge it.",
          "type": "boolean"
        },
        "isOrbytUser": {
          "description": "False for an account known only from the connected network, which clients badge as such.",
          "type": "boolean"
        },
        "joinedAt": {
          "format": "datetime",
          "type": "string"
        },
        "showNetworkLink": {
          "type": "boolean"
        },
        "viewer": {
          "ref": "#viewerState",
          "type": "ref"
        }
      },
      "required": [
        "did",
        "isOrbytUser"
      ],
      "type": "object"
    },
    "viewerState": {
      "description": "The signed-in viewer's Orbyt relationship to this actor. Absent for anonymous reads.",
      "properties": {
        "blocking": {
          "format": "at-uri",
          "type": "string"
        },
        "followedBy": {
          "format": "at-uri",
          "type": "string"
        },
        "following": {
          "description": "The viewer's com.getorbyt.graph.follow record for this actor.",
          "format": "at-uri",
          "type": "string"
        },
        "followingOnNetwork": {
          "description": "Whether the viewer follows this actor on the connected network, as of the viewer's last follow sync. Absent when unknown.",
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "id": "com.getorbyt.actor.defs",
  "lexicon": 1
}
```