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

ChecklistTask

@Serializable

sealed interface ChecklistTask : TextedInput(source)

Inheritors

Input

Created

Types

Completed

@Serializable(with = ChecklistTask.Serializer::class)

sealed interface Completed : ChecklistTask.Created

Created

@Serializable(with = ChecklistTask.Serializer::class)

sealed interface Created : ChecklistTask

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

Serializer

object Serializer : KSerializer<ChecklistTask.Created>

Uncompleted

@Serializable(with = ChecklistTask.Serializer::class)

data class Uncompleted(val id: ChecklistTaskId, val textSources: List<TextSource> = emptyList()) : ChecklistTask.Created

Properties

abstract val id: ChecklistTaskId

text

abstract override val text: String

textSources

abstract 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: