PollMessageSendOptions Interface

{
  "id": 2281,
  "name": "PollMessageSendOptions",
  "variant": "declaration",
  "kind": 256,
  "flags": {},
  "children": [
    {
      "id": 2297,
      "name": "allowSendingWithoutReply",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Pass true if the message should be sent even if the specified replied-to message is not found"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 784,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2286,
      "name": "allowsMultipleAnswers",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to false"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 746,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2282,
      "name": "businessConnectionId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier of the business connection on behalf of which the message will be sent"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 738,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2292,
      "name": "closeDate",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Point in time when the poll will be automatically closed.\nMust be at least 5 and no more than 600 seconds in the future. Can't be used together with "
          },
          {
            "kind": "code",
            "text": "`openPeriod`"
          },
          {
            "kind": "text",
            "text": "."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 770,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": {
          "sourceFileName": "node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es5.d.ts",
          "qualifiedName": "Date"
        },
        "name": "Date",
        "package": "typescript"
      }
    },
    {
      "id": 2287,
      "name": "correctOptionId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "0-based identifier of the correct answer option, required for polls in quiz mode"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 748,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 2294,
      "name": "disableNotification",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sends the message\n[silently](https://telegram.org/blog/channels-2-0#silent-messages).\nUsers will receive a notification with no sound."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 778,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2288,
      "name": "explanation",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll,\n0-200 characters with at most 2 line feeds after entities parsing"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 753,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2290,
      "name": "explanationEntities",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "List of special entities that appear in the poll explanation, which can be specified instead of parseMode"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 760,
          "character": 1
        }
      ],
      "type": {
        "type": "array",
        "elementType": {
          "type": "reference",
          "target": 1625,
          "name": "MessageEntity",
          "package": "tgkit",
          "qualifiedName": "default"
        }
      }
    },
    {
      "id": 2289,
      "name": "explanationParseMode",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Mode for parsing entities in the explanation"
          }
        ],
        "blockTags": [
          {
            "tag": "@see",
            "content": [
              {
                "kind": "inline-tag",
                "tag": "@link",
                "text": "https://core.telegram.org/bots/api#formatting-options",
                "target": "https://core.telegram.org/bots/api#formatting-options"
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 758,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2070,
        "name": "ParseMode",
        "package": "tgkit"
      }
    },
    {
      "id": 2283,
      "name": "forumTopicId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 740,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 2284,
      "name": "isAnonymous",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the poll needs to be anonymous, defaults to *true*"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 742,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2293,
      "name": "isClosed",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Pass *true* if the poll needs to be immediately closed. This can be useful for poll preview."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 772,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2291,
      "name": "openPeriod",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Amount of time in seconds the poll will be active after creation, 5-600.\nCan't be used together with "
          },
          {
            "kind": "code",
            "text": "`closeDate`"
          },
          {
            "kind": "text",
            "text": "."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 765,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 2295,
      "name": "protectContent",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Protects the contents of the sent message from forwarding and saving"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 780,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2298,
      "name": "replyMarkup",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Additional export interface options.\nA JSON-serialized object for an inline keyboard, custom reply keyboard,\ninstructions to remove reply keyboard or to force a reply from the user."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 790,
          "character": 1
        }
      ],
      "type": {
        "type": "union",
        "types": [
          {
            "type": "reference",
            "target": 1379,
            "name": "InlineKeyboardMarkup",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          {
            "type": "reference",
            "target": 1786,
            "name": "ReplyKeyboardMarkup",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          {
            "type": "reference",
            "target": 1816,
            "name": "ReplyKeyboardRemove",
            "package": "tgkit",
            "qualifiedName": "default"
          }
        ]
      }
    },
    {
      "id": 2296,
      "name": "replyToMessageId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "If the message is a reply, ID of the original message"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 782,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 2285,
      "name": "type",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Poll type, 'quiz' or 'regular', defaults to 'regular'"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 744,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2056,
        "name": "PollType",
        "package": "tgkit"
      }
    }
  ],
  "groups": [
    {
      "title": "Properties",
      "children": [
        2297,
        2286,
        2282,
        2292,
        2287,
        2294,
        2288,
        2290,
        2289,
        2283,
        2284,
        2293,
        2291,
        2295,
        2298,
        2296,
        2285
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/types.ts",
      "line": 736,
      "character": 17
    }
  ]
}