docs/dev.inmo.tgbotapi.types.polls/QuizPoll

QuizPoll

@Serializable(with = PollSerializer::class)

data class QuizPoll(val id: PollId, val question: String, val textSources: List<TextSource> = emptyList(), val options: List<PollOption>, val votesCount: Int, val correctOptionIds: List<Int>? = null, val explanation: String?, val explanationTextSources: List<TextSource> = emptyList(), val isClosed: Boolean = false, val isAnonymous: Boolean = false, val allowsMultipleAnswers: Boolean = false, val allowsRevoting: Boolean = false, val scheduledCloseInfo: ScheduledCloseInfo? = null, val descriptionTextSources: List<TextSource> = emptyList(), val media: PollMedia? = null, val explanationMedia: PollMedia? = null, val membersOnly: Boolean = false, val countryCodes: List<String>? = null) : Poll(source)

Constructors

QuizPoll

constructor(id: PollId, question: String, textSources: List<TextSource> = emptyList(), options: List<PollOption>, votesCount: Int, correctOptionIds: List<Int>? = null, explanation: String?, explanationTextSources: List<TextSource> = emptyList(), isClosed: Boolean = false, isAnonymous: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = false, scheduledCloseInfo: ScheduledCloseInfo? = null, descriptionTextSources: List<TextSource> = emptyList(), media: PollMedia? = null, explanationMedia: PollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null)

Properties

allows_multiple_answers

val Poll.allows_multiple_answers: Boolean

allowsMultipleAnswers

open override val allowsMultipleAnswers: Boolean

allowsRevoting

open override val allowsRevoting: Boolean

close_date

val Poll.close_date: TelegramDate?

correct_option_id

val Poll.correct_option_id: List<Int>?

correctOptionIds

val correctOptionIds: List<Int>?

countryCodes

open override val countryCodes: List<String>?

descriptionTextSources

open override val descriptionTextSources: List<TextSource>

explanation

val explanation: String?

explanation

val Poll.explanation: String?

explanation_entities

val Poll.explanation_entities: TextSourcesList?

explanationMedia

val explanationMedia: PollMedia?

explanationTextSources

val explanationTextSources: List<TextSource>

open override val id: PollId

is_anonymous

val Poll.is_anonymous: Boolean

is_closed

val Poll.is_closed: Boolean

isAnonymous

open override val isAnonymous: Boolean

isClosed

open override val isClosed: Boolean

media

open override val media: PollMedia?

membersOnly

open override val membersOnly: Boolean

open_period

val Poll.open_period: Seconds?

options

open override val options: List<PollOption>

question

open override val question: String

questionTextSources

open val questionTextSources: List<TextSource>

scheduledCloseInfo

open override val scheduledCloseInfo: ScheduledCloseInfo?

text

open override val text: String

textSources

open override val textSources: List<TextSource>

Full list of TextSources

total_voter_count

val Poll.total_voter_count: Int

type

val Poll.type: String

votesCount

open override val votesCount: Int

Functions

asQuizPoll

inline fun Poll.asQuizPoll(): QuizPoll?

asRegularPoll

inline fun Poll.asRegularPoll(): RegularPoll?

asUnknownPollType

inline fun Poll.asUnknownPollType(): UnknownPollType?

createRequest

fun Poll.createRequest(chatId: ChatIdentifier, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): SendPoll

ifQuizPoll

inline fun <T> Poll.ifQuizPoll(block: (QuizPoll) -> T): T?

ifRegularPoll

inline fun <T> Poll.ifRegularPoll(block: (RegularPoll) -> T): T?

ifUnknownPollType

inline fun <T> Poll.ifUnknownPollType(block: (UnknownPollType) -> T): T?

parseCommandsWithArgs

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: String): Map<String, Array<String>>

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

Parse commands and their args. Logic will find command, get all subsequent data as args until new command

parseCommandsWithArgsSources

fun TextedWithTextSources.parseCommandsWithArgsSources(): Map<BotCommandTextSource, Array<TextSource>>

Parse text sources to find commands with their arguments. This method will skip all the text sources before first command and all following text sources until the next command will be guessed as an args of last found command

parseCommandsWithNamedArgs

fun TextedWithTextSources.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

fun TextedWithTextSources.parseCommandsWithNamedArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

Uses parseCommandsWithArgs to create base argsSeparator split args for commands and map their as k-v pairs. Sample:

quizPollOrNull