# org.hyperboards.displayProfile

> Published by [hyperboards.org](https://lexicon.garden/identity/did:plc:g3j5fjrhhlfqepq4ncswzhhb)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:g3j5fjrhhlfqepq4ncswzhhb/org.hyperboards.displayProfile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:g3j5fjrhhlfqepq4ncswzhhb/org.hyperboards.displayProfile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:g3j5fjrhhlfqepq4ncswzhhb/org.hyperboards.displayProfile/examples)

## Definitions

### `org.hyperboards.displayProfile`

**Type**: `record`

User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `url` | `string` (uri) | No | Default click-through link URL for this user across boards. |
| `image` | `union` | No | Avatar or face image override for this user on hyperboards, as a URI or image blob. |
| `video` | `union` | No | Default video for this user across boards, as a URI (embed/direct link) or uploaded video blob. |
| `createdAt` | `string` (datetime) | Yes | Client-declared timestamp when this record was originally created. |
| `hoverImage` | `union` | No | Default hover image for this user across boards, as a URI or image blob. |
| `displayName` | `string` | No | Display name override for this user on hyperboards. |
| `hoverIframeUrl` | `string` (uri) | No | Default hover iframe URL for this user across boards. |

## Raw Schema

```json
{
  "id": "org.hyperboards.displayProfile",
  "defs": {
    "main": {
      "key": "literal:self",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "createdAt"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "maxLength": 2048,
            "description": "Default click-through link URL for this user across boards."
          },
          "image": {
            "refs": [
              "org.hypercerts.defs#uri",
              "org.hypercerts.defs#smallImage"
            ],
            "type": "union",
            "description": "Avatar or face image override for this user on hyperboards, as a URI or image blob."
          },
          "video": {
            "refs": [
              "org.hypercerts.defs#uri",
              "org.hypercerts.defs#smallVideo"
            ],
            "type": "union",
            "description": "Default video for this user across boards, as a URI (embed/direct link) or uploaded video blob."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Client-declared timestamp when this record was originally created."
          },
          "hoverImage": {
            "refs": [
              "org.hypercerts.defs#uri",
              "org.hypercerts.defs#smallImage"
            ],
            "type": "union",
            "description": "Default hover image for this user across boards, as a URI or image blob."
          },
          "displayName": {
            "type": "string",
            "maxLength": 640,
            "description": "Display name override for this user on hyperboards.",
            "maxGraphemes": 64
          },
          "hoverIframeUrl": {
            "type": "string",
            "format": "uri",
            "maxLength": 2048,
            "description": "Default hover iframe URL for this user across boards."
          }
        }
      },
      "description": "User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```