com.getorbyt.notification.defs

Repository @getorbyt.com did:plc:2xrqztnmzlckb3xfuuukupso namespace authority
Details · defs
Kinddefs
Authoritynotification.getorbyt.com
Indexed

#display

object

A server-written Activity row.

Properties

badge

string

What sits on the lead image's corner: the author's face, up to three faces from `authors`, or the Community's art. Absent means nothing.

  • knownValues: author | authors | community

lead

requiredstring

Whose image leads the row, and whose name heads it: the author's face and handle, or the Community's art and `/name`. The row comes from whoever the reader would say it came from.

  • knownValues: author | community

text

requiredstring

The sentence after the row's heading, such as `spotlight.orbyt.video and 2 others joined`.

  • maxLength: 600
  • maxGraphemes: 300

#notificationView

object

One Orbyt activity item. Computed when read from Orbyt records and Community service state, never stored.

Properties

authors

array

The newest distinct authors of a gathered item, newest first; the first is `author`. Absent when the item has one author.

  • maxLength: 3

The Community a `community*` reason is about. Absent for other reasons, and absent when the Community can no longer be shown.

count

integer

How many events this item gathers: the joins to one Community in one day, the open reports on one post, or the messages in one Modmail thread. Absent means one. `author` and `indexedAt` are the newest event's.

  • minimum: 1

How the row reads, written by the service so wording, grouping and destinations change without a client release. A client that understands it draws the row from it and keeps its own per-reason wording only for items without one.

Reference

indexedAt

requiredstring · datetime

isRead

requiredboolean

note

string

For a `send` item that gathers one send: the note its sender wrote, so the video can show it when opened.

  • maxLength: 600
  • maxGraphemes: 150

reason

requiredstring

`follow` (legacy): the author followed the viewer with the deprecated Orbyt follow. `followImport` (legacy): 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. `communityAnnouncement`: the mod team of a Community the viewer belongs to set or changed its announcement since the viewer joined; the author is the Community's own account, and it stays listed while the announcement does. `send`: the author sent the viewer a video; the item's record is the post, and the sends of one author in one day are one item. `sendReaction`: the author reacted to a video the viewer sent them. `sendWatched`: the author first looped a video the viewer sent them. 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 | communityAnnouncement | send | sendReaction | sendWatched

uri

requiredstring · at-uri

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`, `communityModmailReply` and `communityAnnouncement` the Community; for `send`, `sendReaction` and `sendWatched` the post sent.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.