Class Poll

constructor

• new Poll(client: TelegramClient | BaseClient, data: Poll): Poll

  Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this

  • data: Poll

    Data about the contains information about a poll

  Returns Poll

allowAnswers

anonymous

closed

OptionalcloseUnixTime

OptionalcorrectId

Optionalexplanation

OptionalexplanationEntities

id

OptionalopenPeriod

Optionaloptions

question

OptionalquestionEntities

totalVoterCount

type

closedAt

• get closedAt(): Date | null

  Point in time when the poll will be automatically closed

  Returns Date | null

closeTimestamp

• get closeTimestamp(): number | null

  Return the timestamp poll will be automatically closed, in milliseconds

  Returns number | null

_patch

• _patch(data: Poll): Poll

  Parameters

  • data: Poll

    Data about the contains information about a poll

  Returns Poll

close

• close(
      chatId: string | number,
      messageId: string | number,
      options?: {
          businessConnectionId?: string;
          replyMarkup?: InlineKeyboardMarkup;
      },
  ): Promise<Omit<Poll, "close">>

  Use this method to stop a poll which was sent by the bot. ONLY BOT POLL

  Parameters

  • chatId: string | number

    Unique identifier for the target chat or username of the target channel (in the format @channelusername).

  • messageId: string | number

    Identifier of the original message with the poll.

  • Optionaloptions: { businessConnectionId?: string; replyMarkup?: InlineKeyboardMarkup }

    options for stopping poll

    • OptionalbusinessConnectionId?: string

      Unique identifier of the business connection on behalf of which the message to be edited was sent.

    • OptionalreplyMarkup?: InlineKeyboardMarkup

      An object for a new message inline keyboard.

  Returns Promise<Omit<Poll, "close">>

  On success, the stopped Poll is returned