pub.chive.collaboration.invite Documentation (EN)

main record

No description available.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

expiresAt string datetime Optional

Optional expiration after which the invite is no longer valid.

invitee string did Required

DID of the user being invited.

message string Optional

Optional personal note shown to the invitee.

maxLength: 500 bytesmaxGraphemes: 200 graphemes

role string Optional

Role granted by this invitation. Defaults to 'collaborator'.

Known values: collaborator, editor, viewer, co-author, reviewer

subject ref com.atproto.repo.strongRef Required

StrongRef to any Chive-authored record being shared (collection, eprint, review, etc.).

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "invitee",
      "createdAt"
    ],
    "properties": {
      "role": {
        "type": "string",
        "description": "Role granted by this invitation. Defaults to 'collaborator'.",
        "knownValues": [
          "collaborator",
          "editor",
          "viewer",
          "co-author",
          "reviewer"
        ]
      },
      "invitee": {
        "type": "string",
        "format": "did",
        "description": "DID of the user being invited."
      },
      "message": {
        "type": "string",
        "maxLength": 500,
        "description": "Optional personal note shown to the invitee.",
        "maxGraphemes": 200
      },
      "subject": {
        "ref": "com.atproto.repo.strongRef",
        "type": "ref",
        "description": "StrongRef to any Chive-authored record being shared (collection, eprint, review, etc.)."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "expiresAt": {
        "type": "string",
        "format": "datetime",
        "description": "Optional expiration after which the invite is no longer valid."
      }
    }
  }
}