us.off-the-clock.polls.poll

off-the-clock.us

Documentation

A question a member asks a content space, with two to ten options that members answer with us.off-the-clock.polls.vote records. Each option is named by a key that stays the same when the poll is edited, so votes follow the option they were cast for. Posts may reply to a poll, so a poll heads a thread.

main record

A question a member asks a content space, with two to ten options that members answer with us.off-the-clock.polls.vote records. Each option is named by a key that stays the same when the poll is edited, so votes follow the option they were cast for. Posts may reply to a poll, so a poll heads a thread.

Record Key tid Timestamp-based ID

Properties

allowMultiple boolean Optional

Voters may choose any set of options; otherwise at most one.

Default: false
closesAt string datetime Optional

Votes cast after this do not count. After opensAt when both are given.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

opensAt string datetime Optional

Votes cast before this do not count.

options array of ref #option Required

In the order shown. Keys are unique within the poll.

maxLength: 10 itemsminLength: 2 items
prompt string Required

No description available.

maxLength: 3000 bytesminLength: 1 bytesmaxGraphemes: 300 graphemesminGraphemes: 1 graphemes
View raw schema 
{
  "description": "A question a member asks a content space, with two to ten options that members answer with us.off-the-clock.polls.vote records. Each option is named by a key that stays the same when the poll is edited, so votes follow the option they were cast for. Posts may reply to a poll, so a poll heads a thread.",
  "key": "tid",
  "record": {
    "properties": {
      "allowMultiple": {
        "default": false,
        "description": "Voters may choose any set of options; otherwise at most one.",
        "type": "boolean"
      },
      "closesAt": {
        "description": "Votes cast after this do not count. After opensAt when both are given.",
        "format": "datetime",
        "type": "string"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "opensAt": {
        "description": "Votes cast before this do not count.",
        "format": "datetime",
        "type": "string"
      },
      "options": {
        "description": "In the order shown. Keys are unique within the poll.",
        "items": {
          "ref": "#option",
          "type": "ref"
        },
        "maxLength": 10,
        "minLength": 2,
        "type": "array"
      },
      "prompt": {
        "maxGraphemes": 300,
        "maxLength": 3000,
        "minGraphemes": 1,
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "prompt",
      "options",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}
option object

No description available.

Properties

allowInput boolean Optional

A voter choosing this option may type an answer beside it.

key string Required

Stable across edits and never reused within the poll; a vote names it.

maxLength: 64 bytesminLength: 1 bytes
text string Required

No description available.

maxLength: 800 bytesminLength: 1 bytesmaxGraphemes: 80 graphemesminGraphemes: 1 graphemes
View raw schema 
{
  "properties": {
    "allowInput": {
      "default": false,
      "description": "A voter choosing this option may type an answer beside it.",
      "type": "boolean"
    },
    "key": {
      "description": "Stable across edits and never reused within the poll; a vote names it.",
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "text": {
      "maxGraphemes": 80,
      "maxLength": 800,
      "minGraphemes": 1,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "text",
    "key"
  ],
  "type": "object"
}

Lexicon Garden

@