# app.lanyards.actor.lanyard

> How a person's lanyard is presented: accent, block order and visibility, hidden items, connect preferences and per-event overrides.

- Kind: record
- Record key: literal:self
- Authority: actor.lanyards.app
- Lexicon: 1
- Published by [lanyards.app](https://lexicon.garden/identity/did:plc:ua3d6biqepazbq6mw4ysotfo), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:ua3d6biqepazbq6mw4ysotfo/app.lanyards.actor.lanyard)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:ua3d6biqepazbq6mw4ysotfo/app.lanyards.actor.lanyard/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:ua3d6biqepazbq6mw4ysotfo/app.lanyards.actor.lanyard/analytics)

## Record (`app.lanyards.actor.lanyard`)

Type: record · key literal:self

### Properties

- `accent` (string): Accent palette; blue when absent or unknown. violet, indigo and ocean are legacy values read as blue; moss and teal as mint; rose, plum and ember as pink
  - Constraints: maxLength: 32, knownValues: blue | mint | lime | pink | violet | indigo | plum | rose | ember | moss | teal | ocean
- `badge` (ref)
  - Reference: `#badgePrefs`
- `blocks` (array): Blocks in display order
  - Constraints: maxLength: 20
  - `items` (ref)
    - Reference: `#block`
- `connect` (ref)
  - Reference: `#connectPrefs`
- `createdAt` (string · datetime, required)
- `events` (array): Per-event lanyard overrides, matched by event URI
  - Constraints: maxLength: 200
  - `items` (ref)
    - Reference: `#eventOverride`
- `hidden` (array): AT-URIs or URLs of individual items hidden from the lanyard
  - Constraints: maxLength: 500
  - `items` (string)
    - Constraints: maxLength: 2048
- `showJob` (boolean): Legacy: show the current role on the badge. Read as badge.showRole when that is absent
  - Constraints: default: true
- `updatedAt` (string · datetime)

## #badgePrefs (`app.lanyards.actor.lanyard#badgePrefs`)

Type: object

How the badge looks: its cover and which headline details it shows

### Properties

- `cover` (string): Cover pattern; derived from the DID when absent or unknown
  - Constraints: maxLength: 32, knownValues: dots | stripes | pixels | orb | symbols | hazard | arrows | monogram
- `showLocation` (boolean): Show the location on the badge
  - Constraints: default: true
- `showOpenTo` (boolean): Show what the owner is open to on the badge
  - Constraints: default: true
- `showRole` (boolean): Show the current role on the badge
  - Constraints: default: true

## #block (`app.lanyards.actor.lanyard#block`)

Type: object

### Properties

- `limit` (integer): How many items to show, for blocks that keep a count; 3 by default
  - Constraints: minimum: 1, maximum: 20
- `type` (ref, required)
  - Reference: `#blockType`
- `visible` (boolean, required)

## #blockType (`app.lanyards.actor.lanyard#blockType`)

Type: string

A block a lanyard can show

Constraints: maxLength: 32, knownValues: links | talks | openTo | blogPosts | bskyPosts | publications | skills | education | code | collections | media | events | details | roles

## #connectPrefs (`app.lanyards.actor.lanyard#connectPrefs`)

Type: object

What a Connect does; each defaults to true

### Properties

- `follow` (boolean)
  - Constraints: default: true
- `metPack` (boolean)
  - Constraints: default: true
- `vouch` (boolean)
  - Constraints: default: true

## #eventOverride (`app.lanyards.actor.lanyard#eventOverride`)

Type: object

### Properties

- `emphasise` (array): Block types moved to the top for this event
  - Constraints: maxLength: 20
  - `items` (ref)
    - Reference: `#blockType`
- `event` (string · at-uri, required): The community.lexicon.calendar.event this override applies to
- `headline` (string)
  - Constraints: maxLength: 1000, maxGraphemes: 100
- `hereFor` (string)
  - Constraints: maxLength: 2000, maxGraphemes: 200
- `metPacks` (array): Starter packs of people met at this event, in rollover order
  - Constraints: maxLength: 20
  - `items` (string · at-uri)

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "badgePrefs": {
      "description": "How the badge looks: its cover and which headline details it shows",
      "properties": {
        "cover": {
          "description": "Cover pattern; derived from the DID when absent or unknown",
          "knownValues": [
            "dots",
            "stripes",
            "pixels",
            "orb",
            "symbols",
            "hazard",
            "arrows",
            "monogram"
          ],
          "maxLength": 32,
          "type": "string"
        },
        "showLocation": {
          "default": true,
          "description": "Show the location on the badge",
          "type": "boolean"
        },
        "showOpenTo": {
          "default": true,
          "description": "Show what the owner is open to on the badge",
          "type": "boolean"
        },
        "showRole": {
          "default": true,
          "description": "Show the current role on the badge",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "block": {
      "properties": {
        "limit": {
          "description": "How many items to show, for blocks that keep a count; 3 by default",
          "maximum": 20,
          "minimum": 1,
          "type": "integer"
        },
        "type": {
          "ref": "#blockType",
          "type": "ref"
        },
        "visible": {
          "type": "boolean"
        }
      },
      "required": [
        "type",
        "visible"
      ],
      "type": "object"
    },
    "blockType": {
      "description": "A block a lanyard can show",
      "knownValues": [
        "links",
        "talks",
        "openTo",
        "blogPosts",
        "bskyPosts",
        "publications",
        "skills",
        "education",
        "code",
        "collections",
        "media",
        "events",
        "details",
        "roles"
      ],
      "maxLength": 32,
      "type": "string"
    },
    "connectPrefs": {
      "description": "What a Connect does; each defaults to true",
      "properties": {
        "follow": {
          "default": true,
          "type": "boolean"
        },
        "metPack": {
          "default": true,
          "type": "boolean"
        },
        "vouch": {
          "default": true,
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "eventOverride": {
      "properties": {
        "emphasise": {
          "description": "Block types moved to the top for this event",
          "items": {
            "ref": "#blockType",
            "type": "ref"
          },
          "maxLength": 20,
          "type": "array"
        },
        "event": {
          "description": "The community.lexicon.calendar.event this override applies to",
          "format": "at-uri",
          "type": "string"
        },
        "headline": {
          "maxGraphemes": 100,
          "maxLength": 1000,
          "type": "string"
        },
        "hereFor": {
          "maxGraphemes": 200,
          "maxLength": 2000,
          "type": "string"
        },
        "metPacks": {
          "description": "Starter packs of people met at this event, in rollover order",
          "items": {
            "format": "at-uri",
            "type": "string"
          },
          "maxLength": 20,
          "type": "array"
        }
      },
      "required": [
        "event"
      ],
      "type": "object"
    },
    "main": {
      "description": "How a person's lanyard is presented: accent, block order and visibility, hidden items, connect preferences and per-event overrides.",
      "key": "literal:self",
      "record": {
        "properties": {
          "accent": {
            "description": "Accent palette; blue when absent or unknown. violet, indigo and ocean are legacy values read as blue; moss and teal as mint; rose, plum and ember as pink",
            "knownValues": [
              "blue",
              "mint",
              "lime",
              "pink",
              "violet",
              "indigo",
              "plum",
              "rose",
              "ember",
              "moss",
              "teal",
              "ocean"
            ],
            "maxLength": 32,
            "type": "string"
          },
          "badge": {
            "ref": "#badgePrefs",
            "type": "ref"
          },
          "blocks": {
            "description": "Blocks in display order",
            "items": {
              "ref": "#block",
              "type": "ref"
            },
            "maxLength": 20,
            "type": "array"
          },
          "connect": {
            "ref": "#connectPrefs",
            "type": "ref"
          },
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "events": {
            "description": "Per-event lanyard overrides, matched by event URI",
            "items": {
              "ref": "#eventOverride",
              "type": "ref"
            },
            "maxLength": 200,
            "type": "array"
          },
          "hidden": {
            "description": "AT-URIs or URLs of individual items hidden from the lanyard",
            "items": {
              "maxLength": 2048,
              "type": "string"
            },
            "maxLength": 500,
            "type": "array"
          },
          "showJob": {
            "default": true,
            "description": "Legacy: show the current role on the badge. Read as badge.showRole when that is absent",
            "type": "boolean"
          },
          "updatedAt": {
            "format": "datetime",
            "type": "string"
          }
        },
        "required": [
          "createdAt"
        ],
        "type": "object"
      },
      "type": "record"
    }
  },
  "id": "app.lanyards.actor.lanyard",
  "lexicon": 1
}
```
