com.getorbyt.notification.defs

{
  "description": "One Orbyt activity item. Computed when read from Orbyt records and Community service state, never stored.",
  "properties": {
    "author": {
      "ref": "com.getorbyt.actor.defs#profileView",
      "type": "ref"
    },
    "community": {
      "description": "The Community a `community*` reason is about. Absent for other reasons, and absent when the Community can no longer be shown.",
      "ref": "com.getorbyt.community.defs#view",
      "type": "ref"
    },
    "indexedAt": {
      "format": "datetime",
      "type": "string"
    },
    "isRead": {
      "type": "boolean"
    },
    "reason": {
      "description": "`follow`: the author followed the viewer on Orbyt. `followImport`: the author's follow came from importing their network follows, so the network never announced it; clients may group these. `friendJoined`: an account the viewer follows on the connected network joined Orbyt. `communityJoined`: the author joined a Community the viewer administers. `communityPostRemoved`: the author, a moderator, removed the viewer's post from a Community; it stays listed while the post is removed. `communityReport`: the author reported a post in a Community the viewer moderates; it stays listed while the report is open. `communityTransferOffered`: the author offered the viewer ownership of a Community; it stays listed while the offer is pending. `communityModmail`: the author, a member, wrote to the mod team of a Community where the viewer holds manage-mail; it stays listed while the thread is open. `communityModmailReply`: the mod team of a Community answered the viewer's Modmail; the author is the Community's own account, because the reply speaks for the team. A client that mirrors follows to the network may leave out `follow`, which the network already reports. A client renders a reason it does not recognise generically or skips it.",
      "knownValues": [
        "follow",
        "followImport",
        "friendJoined",
        "communityJoined",
        "communityPostRemoved",
        "communityReport",
        "communityTransferOffered",
        "communityModmail",
        "communityModmailReply"
      ],
      "type": "string"
    },
    "uri": {
      "description": "The record behind the item: the follow record; for `friendJoined` the joining account's repository (`at://<did>`); for `communityJoined` the membership record; for `communityPostRemoved` and `communityReport` the post; for `communityTransferOffered`, `communityModmail` and `communityModmailReply` the Community.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "reason",
    "author",
    "isRead",
    "indexedAt"
  ],
  "type": "object"
}