Lexicon Garden

fyi.opensocial.getUnread

What's new for the caller in each tab that says what's new in it (its news), in every group on this host they're in: when someone else last added something there, and how much there is for them that they haven't seen. Whether the newest is new to them is theirs to say, from how far they've read, which only they keep.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →
cid bafyreigeuacmugx5thz5ymi6jvnsspoqjegnopyorit4hoasw7mzpkuchi

Checks

Valid
  • unlimited-string defs.placeUnread.properties.channelNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.placeUnread.properties.tabNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "groupUnread": {
      "properties": {
        "group": {
          "format": "did",
          "type": "string"
        },
        "joinedAt": {
          "description": "When the caller joined: in a place they've never read, what came after it is new.",
          "format": "datetime",
          "type": "string"
        },
        "places": {
          "items": {
            "ref": "#placeUnread",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "group",
        "joinedAt",
        "places"
      ],
      "type": "object"
    },
    "main": {
      "description": "What's new for the caller in each tab that says what's new in it (its news), in every group on this host they're in: when someone else last added something there, and how much there is for them that they haven't seen. Whether the newest is new to them is theirs to say, from how far they've read, which only they keep.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "groups": {
              "items": {
                "ref": "#groupUnread",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "groups"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "group": {
            "description": "That group's only.",
            "format": "did",
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "placeUnread": {
      "properties": {
        "channel": {
          "description": "The channel's slug.",
          "type": "string"
        },
        "forYou": {
          "description": "How many things there that answer something of the caller's, or name them, they haven't seen.",
          "minimum": 0,
          "type": "integer"
        },
        "newest": {
          "description": "When the host had the newest thing someone else added there.",
          "format": "datetime",
          "type": "string"
        },
        "room": {
          "description": "In a chat, the record its room is about. Without one, the space as a whole.",
          "format": "at-uri",
          "type": "string"
        },
        "space": {
          "format": "at-uri",
          "type": "string"
        },
        "tab": {
          "description": "The tab's slug.",
          "type": "string"
        }
      },
      "required": [
        "channel",
        "tab",
        "space",
        "forYou"
      ],
      "type": "object"
    }
  },
  "id": "fyi.opensocial.getUnread",
  "lexicon": 1
}