app.atmobb.forum.membership

lexicons.atmobb.app

Documentation

Declares membership in a forum. Lives in the member's own repo, pointing at the forum's DID — joining is an act of the member, leaving is deleting this record.

main record

Declares membership in a forum. Lives in the member's own repo, pointing at the forum's DID — joining is an act of the member, leaving is deleting this record.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

forum string did Required

A decentralized identifier (DID).

guestbook boolean Optional

Whether the member's guestbook on this forum is open for signing. Absent means closed.

guestbookBlocked array of string did Optional

Signers the member blocked from their guestbook; none of their entries show.

maxLength: 500 items
guestbookClosed array of ref #closedPeriod Optional

Periods the guestbook was closed; an entry indexed during one never shows. Turning the guestbook on records the end of the current closed period (or, the first time, a period from the beginning of time to now); turning it off starts a new one. Past 20, the oldest periods merge into one, so nothing they covered resurfaces.

maxLength: 20 items
guestbookHidden array of string at-uri Optional

At-uris of guestbook entries the member hid.

maxLength: 500 items
pinned array of string at-uri Optional

At-uris of the member's own topics on this forum, pinned to their profile page in order.

maxLength: 4 items
wearing array of string Optional

Stamp ids the member wears on this forum, in order: an admin stamp's at-uri, or the fixed id of a generated stamp (atmobb:board:<board at-uri>, atmobb:arrival, atmobb:first-light, atmobb:early-days).

maxLength: 6 items
View raw schema 
{
  "description": "Declares membership in a forum. Lives in the member's own repo, pointing at the forum's DID — joining is an act of the member, leaving is deleting this record.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "forum": {
        "format": "did",
        "type": "string"
      },
      "guestbook": {
        "description": "Whether the member's guestbook on this forum is open for signing. Absent means closed.",
        "type": "boolean"
      },
      "guestbookBlocked": {
        "description": "Signers the member blocked from their guestbook; none of their entries show.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "maxLength": 500,
        "type": "array"
      },
      "guestbookClosed": {
        "description": "Periods the guestbook was closed; an entry indexed during one never shows. Turning the guestbook on records the end of the current closed period (or, the first time, a period from the beginning of time to now); turning it off starts a new one. Past 20, the oldest periods merge into one, so nothing they covered resurfaces.",
        "items": {
          "ref": "#closedPeriod",
          "type": "ref"
        },
        "maxLength": 20,
        "type": "array"
      },
      "guestbookHidden": {
        "description": "At-uris of guestbook entries the member hid.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 500,
        "type": "array"
      },
      "pinned": {
        "description": "At-uris of the member's own topics on this forum, pinned to their profile page in order.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 4,
        "type": "array"
      },
      "wearing": {
        "description": "Stamp ids the member wears on this forum, in order: an admin stamp's at-uri, or the fixed id of a generated stamp (atmobb:board:<board at-uri>, atmobb:arrival, atmobb:first-light, atmobb:early-days).",
        "items": {
          "maxLength": 300,
          "type": "string"
        },
        "maxLength": 6,
        "type": "array"
      }
    },
    "required": [
      "forum"
    ],
    "type": "object"
  },
  "type": "record"
}
closedPeriod object

A span the guestbook was closed. With no end it is closed still.

Properties

from string datetime Required

An RFC 3339 formatted timestamp.

to string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "description": "A span the guestbook was closed. With no end it is closed still.",
  "properties": {
    "from": {
      "format": "datetime",
      "type": "string"
    },
    "to": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "from"
  ],
  "type": "object"
}

Lexicon Garden

@