docs/dev.inmo.tgbotapi.types.checklists/ChecklistTask/Input

Input

@Serializable(with = ChecklistTask.Input.Companion::class)

data class Input(val id: ChecklistTaskId, val text: String, val parseMode: ParseMode? = null, val textSources: List<TextSource> = emptyList()) : ChecklistTask(source)

Constructors

constructor(id: ChecklistTaskId, text: String, parseMode: ParseMode? = null, textSources: List<TextSource> = emptyList())

constructor(id: ChecklistTaskId, text: String, parseMode: ParseMode? = null)

constructor(id: ChecklistTaskId, textSources: List<TextSource>)

constructor(id: ChecklistTaskId, builderBody: EntitiesBuilderBody)

Types

object Companion : KSerializer<ChecklistTask.Input>

Properties

@SerialName(value = "id")

open override val id: ChecklistTaskId

@SerialName(value = "text_parse_mode")

val parseMode: ParseMode?

@SerialName(value = "text")

open override val text: String

@SerialName(value = "text_entities")

open override val textSources: List<TextSource>

Full list of TextSources

Functions

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: