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

Input

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

data class Input(val title: String, val tasks: List<ChecklistTask.Input>, val parseMode: ParseMode? = null, val titleTextSources: List<TextSource> = emptyList(), val othersCanAddTasks: Boolean = false, val othersCanCompleteTasks: Boolean = false) : Checklist(source)

Constructors

Input

constructor(title: String, tasks: List<ChecklistTask.Input>, parseMode: ParseMode? = null, titleTextSources: List<TextSource> = emptyList(), othersCanAddTasks: Boolean = false, othersCanCompleteTasks: Boolean = false)

constructor(text: String, tasks: List<ChecklistTask.Input>, parseMode: ParseMode? = null, othersCanAddTasks: Boolean = false, othersCanCompleteTasks: Boolean = false)

constructor(titleTextSources: List<TextSource>, tasks: List<ChecklistTask.Input>, othersCanAddTasks: Boolean = false, othersCanCompleteTasks: Boolean = false)

constructor(tasks: List<ChecklistTask.Input>, othersCanAddTasks: Boolean = false, othersCanCompleteTasks: Boolean = false, builderBody: EntitiesBuilderBody)

Types

Companion

object Companion : KSerializer<Checklist.Input>

Properties

othersCanAddTasks

@SerialName(value = "others_can_add_tasks")

open override val othersCanAddTasks: Boolean

othersCanCompleteTasks

@SerialName(value = "others_can_mark_tasks_as_done")

open override val othersCanCompleteTasks: Boolean

parseMode

@SerialName(value = "parse_mode")

val parseMode: ParseMode?

tasks

@SerialName(value = "tasks")

open override val tasks: List<ChecklistTask.Input>

text

open override val text: String

textSources

open override val textSources: List<TextSource>

Full list of TextSources

title

@SerialName(value = "title")

open override val title: String

titleTextSources

@SerialName(value = "title_entities")

open override val titleTextSources: List<TextSource>

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: