app.protoimsg.chat.poll Documentation (EN)

main record

A poll within a chat channel. Lives in the creator's repo.

Record Key tid Timestamp-based ID

Properties

allowMultiple boolean Optional

Whether voters can select multiple options.

Default: false

channel string at-uri Required

AT-URI of the channel this poll belongs to.

createdAt string datetime Required

Timestamp of poll creation.

expiresAt string datetime Optional

When the poll closes. Omit for no expiry.

options array of string Required

Poll answer options.

maxLength: 10 itemsminLength: 2 items

question string Required

The poll question.

maxLength: 200 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "channel",
      "question",
      "options",
      "createdAt"
    ],
    "properties": {
      "channel": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the channel this poll belongs to."
      },
      "options": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 100
        },
        "maxLength": 10,
        "minLength": 2,
        "description": "Poll answer options."
      },
      "question": {
        "type": "string",
        "maxLength": 200,
        "description": "The poll question."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of poll creation."
      },
      "expiresAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the poll closes. Omit for no expiry."
      },
      "allowMultiple": {
        "type": "boolean",
        "default": false,
        "description": "Whether voters can select multiple options."
      }
    }
  },
  "description": "A poll within a chat channel. Lives in the creator's repo."
}