org.hypercerts.claim.collection

hypercerts.org

Documentation

A collection/group of items (activities and/or other collections). Collections support recursive nesting.

main record

A collection/group of items (activities and/or other collections). Collections support recursive nesting.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Client-declared timestamp when this record was originally created

items array of ref #item Required

Array of items in this collection with optional weights.

location ref com.atproto.repo.strongRef Optional

A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location.

shortDescription string Optional

Short summary of this collection, suitable for previews and list views

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
title string Required

The title of this collection

maxLength: 800 bytesmaxGraphemes: 80 graphemes
type string Optional

The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "items",
      "createdAt"
    ],
    "properties": {
      "type": {
        "type": "string",
        "description": "The type of this collection. Possible fields can be 'favorites', 'project', or any other type of collection."
      },
      "items": {
        "type": "array",
        "items": {
          "ref": "#item",
          "type": "ref"
        },
        "description": "Array of items in this collection with optional weights."
      },
      "title": {
        "type": "string",
        "maxLength": 800,
        "description": "The title of this collection",
        "maxGraphemes": 80
      },
      "avatar": {
        "refs": [
          "org.hypercerts.defs#uri",
          "org.hypercerts.defs#smallImage"
        ],
        "type": "union",
        "description": "The collection's avatar/profile image as a URI or image blob."
      },
      "banner": {
        "refs": [
          "org.hypercerts.defs#uri",
          "org.hypercerts.defs#largeImage"
        ],
        "type": "union",
        "description": "Larger horizontal image to display behind the collection view."
      },
      "location": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "A strong reference to the location where this collection's activities were performed. The record referenced must conform with the lexicon app.certified.location."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was originally created"
      },
      "description": {
        "ref": "pub.leaflet.pages.linearDocument#main",
        "type": "ref",
        "description": "Rich-text description, represented as a Leaflet linear document."
      },
      "shortDescription": {
        "type": "string",
        "maxLength": 3000,
        "description": "Short summary of this collection, suitable for previews and list views",
        "maxGraphemes": 300
      }
    }
  },
  "description": "A collection/group of items (activities and/or other collections). Collections support recursive nesting."
}
item object

No description available.

Properties

itemIdentifier ref com.atproto.repo.strongRef Required

Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection).

itemWeight string Optional

Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed.

View raw schema 
{
  "type": "object",
  "required": [
    "itemIdentifier"
  ],
  "properties": {
    "itemWeight": {
      "type": "string",
      "description": "Optional weight for this item (positive numeric value stored as string). Weights do not need to sum to a specific total; normalization can be performed by the consuming application as needed."
    },
    "itemIdentifier": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to an item in this collection. Items can be activities (org.hypercerts.claim.activity) and/or other collections (org.hypercerts.claim.collection)."
    }
  }
}

Lexicon Garden

@