app.atmobb.forum.board

lexicons.atmobb.app

Documentation

A board within a forum. Lives in the forum account's repo. Subforums reference their parent board.

main record

A board within a forum. Lives in the forum account's repo. Subforums reference their parent board.

Record Key tid Timestamp-based ID

Properties

access union Optional

Who can read this board. Defaults to public when absent.

Known types:
category string at-uri Optional

Category this board is grouped under on the index. Must reference an app.atmobb.forum.category in the same repo.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
name string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
order integer Optional

Sort position within the parent (or the forum root).

minimum: 0
parent string at-uri Optional

Parent board for subforums. Must reference an app.atmobb.forum.board in the same repo.

topic string Optional

Normalized topic slug (lowercase, hyphen-separated). Boards across the atmosphere sharing a topic merge their threads; appviews do the joining.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
topicAllow array of string did Optional

Allowlist mode: forums whose same-topic boards merge here.

maxLength: 100 items
topicFederation string Optional

Whose boards merge into this board's topic window. Absent means open.

maxLength: 64 bytes
Known values: open, allowlist
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 1000,
        "maxGraphemes": 100
      },
      "order": {
        "type": "integer",
        "minimum": 0,
        "description": "Sort position within the parent (or the forum root)."
      },
      "topic": {
        "type": "string",
        "maxLength": 640,
        "description": "Normalized topic slug (lowercase, hyphen-separated). Boards across the atmosphere sharing a topic merge their threads; appviews do the joining.",
        "maxGraphemes": 64
      },
      "access": {
        "refs": [
          "#public",
          "#space"
        ],
        "type": "union",
        "description": "Who can read this board. Defaults to public when absent."
      },
      "parent": {
        "type": "string",
        "format": "at-uri",
        "description": "Parent board for subforums. Must reference an app.atmobb.forum.board in the same repo."
      },
      "category": {
        "type": "string",
        "format": "at-uri",
        "description": "Category this board is grouped under on the index. Must reference an app.atmobb.forum.category in the same repo."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "topicAllow": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "maxLength": 100,
        "description": "Allowlist mode: forums whose same-topic boards merge here."
      },
      "description": {
        "type": "string",
        "maxLength": 10000,
        "maxGraphemes": 1000
      },
      "topicFederation": {
        "type": "string",
        "maxLength": 64,
        "description": "Whose boards merge into this board's topic window. Absent means open.",
        "knownValues": [
          "open",
          "allowlist"
        ]
      }
    }
  },
  "description": "A board within a forum. Lives in the forum account's repo. Subforums reference their parent board."
}
public object

Anyone can read; threads and replies are public repo records.

This object has no properties defined.

View raw schema 
{
  "type": "object",
  "properties": {},
  "description": "Anyone can read; threads and replies are public repo records."
}
space object

Members-only board. Threads and replies live in the referenced permissioned space rather than public repos.

Properties

space string Required

The ats:// URI of the permissioned space backing this board.

maxLength: 1000 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "space"
  ],
  "properties": {
    "space": {
      "type": "string",
      "maxLength": 1000,
      "description": "The ats:// URI of the permissioned space backing this board."
    }
  },
  "description": "Members-only board. Threads and replies live in the referenced permissioned space rather than public repos."
}

Lexicon Garden

@