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

Completed

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

sealed interface Completed : ChecklistTask.Created(source)

Inheritors

Types

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

data class ByChat(val id: ChecklistTaskId, val completedByChat: PreviewChat, val completionDate: TelegramDate, val textSources: List<TextSource> = emptyList()) : ChecklistTask.Completed

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

data class ByUser(val id: ChecklistTaskId, val completedByUser: PreviewUser, val completionDate: TelegramDate, val textSources: List<TextSource> = emptyList()) : ChecklistTask.Completed

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

data class Common(val id: ChecklistTaskId, val completionDate: TelegramDate, val textSources: List<TextSource> = emptyList()) : ChecklistTask.Completed

Properties

completedByChat

open val completedByChat: PreviewChat?

completedByUser

open val completedByUser: PreviewUser?

open val completionDate: TelegramDate?

abstract val id: ChecklistTaskId

abstract override val text: String

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: