InputMessagePoll class final

A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat

Inheritance
Available extensions
Annotations
  • @immutable

Constructors

InputMessagePoll({FormattedText? question, required List<InputPollOption> options, FormattedText? description, InputPollMedia? media, required bool isAnonymous, required bool allowsMultipleAnswers, required bool allowsRevoting, required bool membersOnly, required List<String> countryCodes, required bool shuffleOptions, required bool hideResultsUntilCloses, InputPollType? type, required int openPeriod, required int closeDate, bool? isClosed})

Properties

allowsMultipleAnswers → bool
allowsMultipleAnswers True, if multiple answer options can be chosen simultaneously
final
allowsRevoting → bool
allowsRevoting True, if the poll can be answered multiple times
final
closeDate → int
closeDate Point in time (Unix timestamp) when the poll will automatically be closed; must be 0-getOption("poll_open_period_max") seconds in the future; pass 0 if not specified
final
countryCodes → List<String>
countryCodes The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be able to vote; for channel chats only. If empty, then all users can participate in the poll. There can be up to getOption("poll_country_count_max") chosen countries
final
description → FormattedText?
param_description Poll description; pass null to use an empty description; 0-getOption("message_caption_length_max") characters
final
hashCode → int
The hash code for this object.
no setteroverride
hideResultsUntilCloses → bool
hideResultsUntilCloses True, if the poll results will appear only after the poll closes
final
isAnonymous → bool
isAnonymous True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels
final
isClosed → bool?
isClosed True, if the poll needs to be sent already closed; for bots only
final
media → InputPollMedia?
media Media attached to the poll; pass null if none. Must be one of the following types: inputPollMediaAnimation, inputPollMediaAudio, inputPollMediaDocument, inputPollMediaLocation, inputPollMediaPhoto, inputPollMediaVenue, or inputPollMediaVideo without caption
final
membersOnly → bool
membersOnly True, if only the users that are members of the chat for more than a day will be able to vote; for channel chats only
final
openPeriod → int
openPeriod Amount of time the poll will be active after creation, in seconds; 0-getOption("poll_open_period_max"); pass 0 if not specified
final
options → List<InputPollOption>
options List of poll answer options; 1-getOption("poll_answer_count_max") options
final
question → FormattedText?
question Poll question; 1-255 characters (up to 300 characters for bots). Only custom emoji entities are allowed to be added and only by Premium users
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shuffleOptions → bool
shuffleOptions True, if poll options must be shown in a fixed random order
final
type → InputPollType?
type Type of the poll
final

Methods

copyWith({FormattedText? question, List<InputPollOption>? options, FormattedText? description, InputPollMedia? media, bool? isAnonymous, bool? allowsMultipleAnswers, bool? allowsRevoting, bool? membersOnly, List<String>? countryCodes, bool? shuffleOptions, bool? hideResultsUntilCloses, InputPollType? type, int? openPeriod, int? closeDate, bool? isClosed}) → InputMessagePoll

Available on InputMessagePoll, provided by the InputMessagePollExtensions extension

getConstructor() → String
override
map<TResult extends Object?>({required TResult inputMessageAnimation(InputMessageAnimation value), required TResult inputMessageAudio(InputMessageAudio value), required TResult inputMessageChecklist(InputMessageChecklist value), required TResult inputMessageContact(InputMessageContact value), required TResult inputMessageDice(InputMessageDice value), required TResult inputMessageDocument(InputMessageDocument value), required TResult inputMessageForwarded(InputMessageForwarded value), required TResult inputMessageGame(InputMessageGame value), required TResult inputMessageInvoice(InputMessageInvoice value), required TResult inputMessageLiveLocation(InputMessageLiveLocation value), required TResult inputMessageLocation(InputMessageLocation value), required TResult inputMessagePaidMedia(InputMessagePaidMedia value), required TResult inputMessagePhoto(InputMessagePhoto value), required TResult inputMessagePoll(InputMessagePoll value), required TResult inputMessageRichMessage(InputMessageRichMessage value), required TResult inputMessageStakeDice(InputMessageStakeDice value), required TResult inputMessageSticker(InputMessageSticker value), required TResult inputMessageStory(InputMessageStory value), required TResult inputMessageText(InputMessageText value), required TResult inputMessageVenue(InputMessageVenue value), required TResult inputMessageVideo(InputMessageVideo value), required TResult inputMessageVideoNote(InputMessageVideoNote value), required TResult inputMessageVoiceNote(InputMessageVoiceNote value)}) → TResult

Available on InputMessageContent, provided by the InputMessageContentExtensions extension

maybeMap<TResult extends Object?>({TResult inputMessageAnimation(InputMessageAnimation value)?, TResult inputMessageAudio(InputMessageAudio value)?, TResult inputMessageChecklist(InputMessageChecklist value)?, TResult inputMessageContact(InputMessageContact value)?, TResult inputMessageDice(InputMessageDice value)?, TResult inputMessageDocument(InputMessageDocument value)?, TResult inputMessageForwarded(InputMessageForwarded value)?, TResult inputMessageGame(InputMessageGame value)?, TResult inputMessageInvoice(InputMessageInvoice value)?, TResult inputMessageLiveLocation(InputMessageLiveLocation value)?, TResult inputMessageLocation(InputMessageLocation value)?, TResult inputMessagePaidMedia(InputMessagePaidMedia value)?, TResult inputMessagePhoto(InputMessagePhoto value)?, TResult inputMessagePoll(InputMessagePoll value)?, TResult inputMessageRichMessage(InputMessageRichMessage value)?, TResult inputMessageStakeDice(InputMessageStakeDice value)?, TResult inputMessageSticker(InputMessageSticker value)?, TResult inputMessageStory(InputMessageStory value)?, TResult inputMessageText(InputMessageText value)?, TResult inputMessageVenue(InputMessageVenue value)?, TResult inputMessageVideo(InputMessageVideo value)?, TResult inputMessageVideoNote(InputMessageVideoNote value)?, TResult inputMessageVoiceNote(InputMessageVoiceNote value)?, required TResult orElse()}) → TResult

Available on InputMessageContent, provided by the InputMessageContentExtensions extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
override

Constants

constructor → const String