tgbotapi.utils/dev.inmo.tgbotapi.extensions.utils.extensions

Package-level declarations

Types

TelegramBotCommandsDefaults

object TelegramBotCommandsDefaults

Properties

defaultArgsSeparator

val ~~defaultArgsSeparator~~: Regex

Functions

download

suspend fun PathedFile.download(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper, client: HttpClient = HttpClient()): ByteArray

fromChat

inline fun <T : WithPreviewChat> Flow<T>.fromChat(chatId: ChatIdentifier): Flow<T>

Will pass only those T which have sameChat as chatId

inline fun <T : WithPreviewChat> Flow<T>.fromChat(chat: Chat): Flow<T>

Will pass only those T which have sameChat as chatId

fromUser

inline fun <T : FromUser> Flow<T>.fromUser(userId: UserId): Flow<T>

inline fun <T : FromUser> Flow<T>.fromUser(user: User): Flow<T>

loadFile

suspend fun HttpClient.loadFile(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper, pathedFile: PathedFile): ByteArray

suspend fun HttpClient.loadFile(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper, filePath: String): ByteArray

parseCommandsWithArgs

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: String): Map<String, Array<String>>

fun TextedWithTextSources.parseCommandsWithArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

fun ContentMessage<TextContent>.parseCommandsWithArgs(argsSeparator: String): Map<String, Array<String>>

fun ContentMessage<TextContent>.parseCommandsWithArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

fun List<TextSource>.parseCommandsWithArgs(argsSeparator: String): MutableMap<String, Array<String>>

fun List<TextSource>.parseCommandsWithArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): MutableMap<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>>

fun ContentMessage<TextContent>.parseCommandsWithArgsSources(): Map<BotCommandTextSource, Array<TextSource>>

fun List<TextSource>.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>>>

fun ContentMessage<TextContent>.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

fun ContentMessage<TextContent>.parseCommandsWithNamedArgs(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

fun List<TextSource>.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: Regex = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<Pair<String, String>>>

fun List<TextSource>.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:

parseCommandsWithParams

fun TextedWithTextSources.~~parseCommandsWithParams~~(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

fun ContentMessage<TextContent>.~~parseCommandsWithParams~~(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): Map<String, Array<String>>

fun List<TextSource>.~~parseCommandsWithParams~~(argsSeparator: Regex = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): MutableMap<String, Array<String>>

Parse commands and their args. Logic will find command, get all subsequent data as args until new command

sameChat

inline fun WithPreviewChat.sameChat(chatId: ChatIdentifier): Boolean

inline fun WithPreviewChat.sameChat(chat: Chat): Boolean

inline fun WithPreviewChat.sameChat(other: Message): Boolean

sameMessage

inline fun Message.sameMessage(other: Message): Boolean

inline fun Message.sameMessage(chatId: ChatIdentifier, messageId: MessageId): Boolean

inline fun Message.sameMessage(chat: Chat, messageId: MessageId): Boolean

sameThread

inline fun Message.sameThread(other: Message): Boolean

inline fun Message.sameThread(chatId: ChatIdentifier, threadId: MessageThreadId? = chatId.threadId): Boolean

inline fun Message.sameThread(chat: Chat, threadId: MessageThreadId? = chat.id.threadId): Boolean

Thread is the same thing that topic

sameTopic

inline fun Message.sameTopic(other: Message): Boolean

inline fun Message.sameTopic(chatId: ChatIdentifier, threadId: MessageThreadId? = chatId.threadId): Boolean

inline fun Message.sameTopic(chat: Chat, threadId: MessageThreadId? = chat.id.threadId): Boolean

Thread is the same thing that topic

sourceChat

fun CallbackQuery.sourceChat(): PreviewChat?

fun Update.sourceChat(): Chat?

sourceChatWithConverters

fun Update.sourceChatWithConverters(baseMessageUpdateConverter: (BaseMessageUpdate) -> Chat? = { it.data.chat }, chatJoinRequestUpdateConverter: (ChatJoinRequestUpdate) -> Chat? = { it.data.chat }, shippingQueryUpdateConverter: (ShippingQueryUpdate) -> Chat? = { null }, pollAnswerUpdateConverter: (PollAnswerUpdate) -> Chat? = { null }, preCheckoutQueryUpdateConverter: (PreCheckoutQueryUpdate) -> Chat? = { it.data.from }, callbackQueryUpdateConverter: (CallbackQueryUpdate) -> Chat? = { it.data.sourceChat() }, chosenInlineResultUpdateConverter: (ChosenInlineResultUpdate) -> Chat? = { null }, inlineQueryUpdateConverter: (InlineQueryUpdate) -> Chat? = { null }, pollUpdateConverter: (PollUpdate) -> Chat? = { null }, channelPostUpdateConverter: (ChannelPostUpdate) -> Chat? = { it.data.chat }, messageUpdateConverter: (MessageUpdate) -> Chat? = { it.data.chat }, editChannelPostUpdateConverter: (EditChannelPostUpdate) -> Chat? = { it.data.chat }, editMessageUpdateConverter: (EditMessageUpdate) -> Chat? = { it.data.chat }, myChatMemberUpdatedUpdateConverter: (MyChatMemberUpdatedUpdate) -> Chat? = { it.data.chat }, commonChatMemberUpdatedUpdateConverter: (CommonChatMemberUpdatedUpdate) -> Chat? = { it.data.chat }): Chat?

sourceUser

fun Update.sourceUser(): User?