is.currents.feed.defs

currents.is

Documentation

collectionView object

No description available.

Properties

cid string cid Required

CID of the collection record.

createdAt string datetime Required

Creation time of the collection record.

description string Optional

Optional description shown with the collection.

name string Required

Collection display name.

previewImages array of stringuri Optional

Up to four CDN preview image URLs for items in the collection.

maxLength: 4 items
saveCount integer Optional

Number of saves currently in the collection.

uri string at-uri Required

AT-URI of the collection record.

viewer ref #collectionViewerState Optional

Viewer-specific state. Only present when the request is authenticated.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "author",
    "name",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the collection record."
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the collection record."
    },
    "name": {
      "type": "string",
      "description": "Collection display name."
    },
    "author": {
      "ref": "is.currents.actor.defs#profileView",
      "type": "ref",
      "description": "Profile view of the account that owns the collection."
    },
    "viewer": {
      "ref": "#collectionViewerState",
      "type": "ref",
      "description": "Viewer-specific state. Only present when the request is authenticated."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation time of the collection record."
    },
    "saveCount": {
      "type": "integer",
      "description": "Number of saves currently in the collection."
    },
    "description": {
      "type": "string",
      "description": "Optional description shown with the collection."
    },
    "previewImages": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "maxLength": 4,
      "description": "Up to four CDN preview image URLs for items in the collection."
    }
  }
}
collectionViewerState object

Metadata about the requesting account's relationship with this collection. Only present when the request is authenticated.

Properties

starred boolean Optional

Whether the authenticated user has starred this collection.

View raw schema
{
  "type": "object",
  "properties": {
    "starred": {
      "type": "boolean",
      "description": "Whether the authenticated user has starred this collection."
    }
  },
  "description": "Metadata about the requesting account's relationship with this collection. Only present when the request is authenticated."
}
saveView object

No description available.

Properties

createdAt string datetime Required

Creation time of the save record.

originUrl string uri Optional

Original source URL associated with the saved item, if known.

text string Optional

Optional user-authored note attached to the save.

uri string at-uri Required

AT-URI of the save record.

viewer ref #saveViewerState Optional

Viewer-specific state. Only present when the request is authenticated.

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "author",
    "content",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the save record."
    },
    "text": {
      "type": "string",
      "description": "Optional user-authored note attached to the save."
    },
    "author": {
      "ref": "is.currents.actor.defs#profileView",
      "type": "ref",
      "description": "Profile view of the account that created the save."
    },
    "viewer": {
      "ref": "#saveViewerState",
      "type": "ref",
      "description": "Viewer-specific state. Only present when the request is authenticated."
    },
    "content": {
      "refs": [
        "is.currents.content.defs#imageView"
      ],
      "type": "union",
      "closed": false,
      "description": "Content payload for this save."
    },
    "resaveOf": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref",
      "description": "Strong reference to the original save record when this save is a resave."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation time of the save record."
    },
    "originUrl": {
      "type": "string",
      "format": "uri",
      "description": "Original source URL associated with the saved item, if known."
    }
  }
}
saveViewerState object

Metadata about the requesting account's relationship with this save. Only present when the request is authenticated.

Properties

saves array of object Optional

The viewer's own saves of this item, one per collection they have saved it in.

View raw schema
{
  "type": "object",
  "properties": {
    "saves": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "collectionUri",
          "saveUri"
        ],
        "properties": {
          "saveUri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the viewer's save record."
          },
          "collectionUri": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the viewer collection containing this save."
          }
        }
      },
      "description": "The viewer's own saves of this item, one per collection they have saved it in."
    }
  },
  "description": "Metadata about the requesting account's relationship with this save. Only present when the request is authenticated."
}

Lexicon Garden

@