docs/dev.inmo.tgbotapi.requests.send.polls/SendRegularPoll

SendRegularPoll

@Serializable

class SendRegularPoll(val chatId: ChatIdentifier, val question: String, val options: List<InputPollOption>, val questionParseMode: ParseMode? = null, rawQuestionEntities: List<RawMessageEntity> = emptyList(), val isAnonymous: Boolean = true, val isClosed: Boolean = false, val allowsMultipleAnswers: Boolean = false, val allowsRevoting: Boolean = true, val shuffleOptions: Boolean = false, val allowAddingOptions: Boolean = false, val hideResultsUntilCloses: Boolean = false, val description: String? = null, val descriptionParseMode: ParseMode? = null, rawDescriptionEntities: List<RawMessageEntity>? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, val media: InputPollMedia? = null, val membersOnly: Boolean = false, val countryCodes: List<String>? = null, val threadId: MessageThreadId? = chatId.threadId, val directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val allowPaidBroadcast: Boolean = false, val effectId: EffectId? = null, val suggestedPostParameters: SuggestedPostParameters? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: KeyboardMarkup? = null) : SendPoll(source)

Constructors

SendRegularPoll

constructor(chatId: ChatIdentifier, question: String, options: List<InputPollOption>, questionParseMode: ParseMode? = null, rawQuestionEntities: List<RawMessageEntity> = emptyList(), isAnonymous: Boolean = true, isClosed: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = true, shuffleOptions: Boolean = false, allowAddingOptions: Boolean = false, hideResultsUntilCloses: Boolean = false, description: String? = null, descriptionParseMode: ParseMode? = null, rawDescriptionEntities: List<RawMessageEntity>? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null)

constructor(chatId: ChatIdentifier, questionTextSources: List<TextSource>, options: List<InputPollOption>, isAnonymous: Boolean = true, isClosed: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = true, shuffleOptions: Boolean = false, allowAddingOptions: Boolean = false, hideResultsUntilCloses: Boolean = false, description: String? = null, descriptionParseMode: ParseMode? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null)

constructor(chatId: ChatIdentifier, question: String, options: List<InputPollOption>, questionParseMode: ParseMode? = null, isAnonymous: Boolean = true, isClosed: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = true, shuffleOptions: Boolean = false, allowAddingOptions: Boolean = false, hideResultsUntilCloses: Boolean = false, description: String? = null, descriptionParseMode: ParseMode? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null)

constructor(chatId: ChatIdentifier, question: String, options: List<InputPollOption>, questionParseMode: ParseMode? = null, isAnonymous: Boolean = true, isClosed: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = true, shuffleOptions: Boolean = false, allowAddingOptions: Boolean = false, hideResultsUntilCloses: Boolean = false, descriptionTextSources: List<TextSource>? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null)

constructor(chatId: ChatIdentifier, questionTextSources: List<TextSource>, options: List<InputPollOption>, isAnonymous: Boolean = true, isClosed: Boolean = false, allowsMultipleAnswers: Boolean = false, allowsRevoting: Boolean = true, shuffleOptions: Boolean = false, allowAddingOptions: Boolean = false, hideResultsUntilCloses: Boolean = false, descriptionTextSources: List<TextSource>? = null, openPeriod: LongSeconds? = null, closeDate: LongSeconds? = null, media: InputPollMedia? = null, membersOnly: Boolean = false, countryCodes: List<String>? = null, threadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null)

Properties

allowAddingOptions

@SerialName(value = "allow_adding_options")

val allowAddingOptions: Boolean

allowPaidBroadcast

@SerialName(value = "allow_paid_broadcast")

open override val allowPaidBroadcast: Boolean

allowSendingWithoutReply

open val allowSendingWithoutReply: Boolean?

allowsMultipleAnswers

@SerialName(value = "allows_multiple_answers")

open override val allowsMultipleAnswers: Boolean

allowsRevoting

@SerialName(value = "allows_revoting")

open override val allowsRevoting: Boolean

businessConnectionId

@SerialName(value = "business_connection_id")

open override val businessConnectionId: BusinessConnectionId?

chatId

@SerialName(value = "chat_id")

open override val chatId: ChatIdentifier

closeInfo

open val closeInfo: ScheduledCloseInfo?

countryCodes

@SerialName(value = "country_codes")

val countryCodes: List<String>?

description

@SerialName(value = "description")

open override val description: String?

descriptionParseMode

@SerialName(value = "description_parse_mode")

val descriptionParseMode: ParseMode?

descriptionTextSources

open override val descriptionTextSources: List<TextSource>?

directMessageThreadId

@EncodeDefault

@SerialName(value = "direct_messages_topic_id")

open override val directMessageThreadId: DirectMessageThreadId?

disableNotification

@SerialName(value = "disable_notification")

open override val disableNotification: Boolean

effectId

@SerialName(value = "message_effect_id")

open override val effectId: EffectId?

hideResultsUntilCloses

@SerialName(value = "hide_results_until_closes")

open override val hideResultsUntilCloses: Boolean

isAnonymous

@SerialName(value = "is_anonymous")

open override val isAnonymous: Boolean

isClosed

@SerialName(value = "is_closed")

open override val isClosed: Boolean

media

@SerialName(value = "media")

val media: InputPollMedia?

membersOnly

@SerialName(value = "members_only")

val membersOnly: Boolean

options

@SerialName(value = "options")

open override val options: List<InputPollOption>

protectContent

@SerialName(value = "protect_content")

open override val protectContent: Boolean

question

@SerialName(value = "question")

open override val question: String

questionParseMode

@SerialName(value = "question_parse_mode")

open override val questionParseMode: ParseMode?

replyMarkup

@SerialName(value = "reply_markup")

open override val replyMarkup: KeyboardMarkup?

replyParameters

@SerialName(value = "reply_parameters")

open override val replyParameters: ReplyParameters?

replyToMessageId

open val replyToMessageId: MessageId?

requestSerializer

open override val requestSerializer: SerializationStrategy<*>

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<ChatContentMessage<PollContent>>

shuffleOptions

@SerialName(value = "shuffle_options")

open override val shuffleOptions: Boolean

suggestedPostParameters

@SerialName(value = "suggested_post_parameters")

open override val suggestedPostParameters: SuggestedPostParameters?

text

open override val text: String

textSources

open override val textSources: List<TextSource>

Full list of TextSources

threadId

@SerialName(value = "message_thread_id")

@EncodeDefault

open override val threadId: MessageThreadId?

type

open override val type: String

Functions

method

open override fun method(): String

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: