page.corvus.block Documentation (EN)

main record

No description available.

Record Key tid Timestamp-based ID

Properties

blockId string at-uri Optional

The URI of the block record that created this block, omitted if this is the record that created the block

collaborators array of string did Optional

A list of dids that are collaborators on the block

createdAt string datetime Required

The ISO 8601 datetime the block was created

inline unknown Optional

Map of inline blocks, keyed by inline-tid. Each value is a `page.corvus.block#main` record body (the inline block's `ops`/`createdAt`/`inline`). Block-ids address inline blocks as `<this-record-uri>#inline/<inline-tid>`, with deeper nesting appended as `/inline/<inline-tid>` per level. Modeled as `unknown` because lexicons don't yet support map types; the runtime shape is `{ [inlineTid: string]: page.corvus.block#main }`.

ops array of union Required

The edits that have been applied to this block

Known types:

#create
#insert
#delete
#set
#increment
#add
#remove

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "ops",
      "createdAt"
    ],
    "properties": {
      "ops": {
        "type": "array",
        "items": {
          "refs": [
            "#create",
            "#insert",
            "#delete",
            "#set",
            "#increment",
            "#add",
            "#remove"
          ],
          "type": "union",
          "closed": true
        },
        "description": "The edits that have been applied to this block"
      },
      "inline": {
        "type": "unknown",
        "description": "Map of inline blocks, keyed by inline-tid. Each value is a `page.corvus.block#main` record body (the inline block's `ops`/`createdAt`/`inline`). Block-ids address inline blocks as `<this-record-uri>#inline/<inline-tid>`, with deeper nesting appended as `/inline/<inline-tid>` per level. Modeled as `unknown` because lexicons don't yet support map types; the runtime shape is `{ [inlineTid: string]: page.corvus.block#main }`."
      },
      "blockId": {
        "type": "string",
        "format": "at-uri",
        "description": "The URI of the block record that created this block, omitted if this is the record that created the block"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "The ISO 8601 datetime the block was created"
      },
      "collaborators": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "description": "A list of dids that are collaborators on the block"
      }
    },
    "description": "A block record containing the edits that have been applied to this block by the owning user."
  }
}

add object

Add a value to an OR-Set on this block

Properties

after string Optional

The operation id that removed this value from the set previously

id string Required

The operation id

set string Required

The name of the set to add to

value unknown Required

The value to add to the set

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "set",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "set": {
      "type": "string",
      "description": "The name of the set to add to"
    },
    "after": {
      "type": "string",
      "description": "The operation id that removed this value from the set previously"
    },
    "value": {
      "type": "unknown",
      "description": "The value to add to the set"
    }
  },
  "description": "Add a value to an OR-Set on this block"
}

create object

create a new block

Properties

blockType string nsid Required

The type of the block

Known values: page.corvus.document, page.corvus.document#prose, page.corvus.database

data unknown Optional

The data to create the block with

View raw schema

{
  "type": "object",
  "required": [
    "blockType"
  ],
  "properties": {
    "data": {
      "type": "unknown",
      "description": "The data to create the block with"
    },
    "blockType": {
      "type": "string",
      "format": "nsid",
      "description": "The type of the block",
      "knownValues": [
        "page.corvus.document",
        "page.corvus.document#prose",
        "page.corvus.database"
      ]
    }
  },
  "description": "create a new block"
}

delete object

Delete from an RGA sequence on this block

Properties

after string Required

The operation id of the atom to delete after

afterAtom integer Required

The index of the atom to delete after

count integer Required

The number of atoms to delete

id string Required

The operation id

seq string Required

The name of the sequence to delete from

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "seq",
    "count",
    "after",
    "afterAtom"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "seq": {
      "type": "string",
      "description": "The name of the sequence to delete from"
    },
    "after": {
      "type": "string",
      "description": "The operation id of the atom to delete after"
    },
    "count": {
      "type": "integer",
      "description": "The number of atoms to delete"
    },
    "afterAtom": {
      "type": "integer",
      "description": "The index of the atom to delete after"
    }
  },
  "description": "Delete from an RGA sequence on this block"
}

increment object

Increment a counter on this block

Properties

counter string Required

The name of the counter to increment

delta integer Required

The amount to increment the counter by

id string Required

The operation id

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "counter",
    "delta"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "delta": {
      "type": "integer",
      "description": "The amount to increment the counter by"
    },
    "counter": {
      "type": "string",
      "description": "The name of the counter to increment"
    }
  },
  "description": "Increment a counter on this block"
}

insert object

Insert into an RGA sequence on this block

Properties

after string Optional

The operation id of the atom to insert after

afterAtom integer Optional

The index of the atom to insert after

id string Required

The operation id

seq string Required

The name of the sequence to insert into

value unknown Required

The value to insert into the sequence, either a string for text sequences or an array for list sequences

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "seq",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "seq": {
      "type": "string",
      "description": "The name of the sequence to insert into"
    },
    "after": {
      "type": "string",
      "description": "The operation id of the atom to insert after"
    },
    "value": {
      "type": "unknown",
      "description": "The value to insert into the sequence, either a string for text sequences or an array for list sequences"
    },
    "afterAtom": {
      "type": "integer",
      "description": "The index of the atom to insert after"
    }
  },
  "description": "Insert into an RGA sequence on this block"
}

remove object

Remove a value from an OR-Set on this block

Properties

after string Required

The operation id that added this value to the set previously

id string Required

The operation id

set string Required

The name of the set to remove from

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "set",
    "after"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "set": {
      "type": "string",
      "description": "The name of the set to remove from"
    },
    "after": {
      "type": "string",
      "description": "The operation id that added this value to the set previously"
    }
  },
  "description": "Remove a value from an OR-Set on this block"
}

set object

Set a value on an LWW register on this block

Properties

after string Optional

The operation id that last wrote to this register

id string Required

The operation id

register string Required

The name of the register to set

value unknown Required

The value to set on the register

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "register",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The operation id"
    },
    "after": {
      "type": "string",
      "description": "The operation id that last wrote to this register"
    },
    "value": {
      "type": "unknown",
      "description": "The value to set on the register"
    },
    "register": {
      "type": "string",
      "description": "The name of the register to set"
    }
  },
  "description": "Set a value on an LWW register on this block"
}