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

Package-level declarations

Types

Link copied to clipboard

Properties

Link copied to clipboard
val <Error class: unknown class>.becameOwner: Boolean

Member became a chat owner

Link copied to clipboard
val <Error class: unknown class>.ceasedOwnership: Boolean

Member ceased their chat ownership

Link copied to clipboard
val <Error class: unknown class>.gotDemoted: Boolean

Member was demoted from administrators (or ceased chat ownership)

Link copied to clipboard
val <Error class: unknown class>.gotPromoted: Boolean

Member was promoted to chat administrator (or owner)

Link copied to clipboard
val <Error class: unknown class>.gotPromotionChanged: Boolean

Member was promoted to chat administrator (or owner) or got it permissions/title changed

Link copied to clipboard
val <Error class: unknown class>.gotRestricted: Boolean

Member was restricted or some restrictions have changed

Link copied to clipboard
val <Error class: unknown class>.gotRestrictionsChanged: Boolean

Member restrictions were changed (but not removed)

Link copied to clipboard
val <Error class: unknown class>.gotUnrestricted: Boolean

All member restrictions were removed

Link copied to clipboard
val <Error class: unknown class>.isAdministrator: Boolean

Check if receiver object is AdministratorChatMember

Link copied to clipboard
val <Error class: unknown class>.isBanned: Boolean

Check that member is KickedChatMember

Link copied to clipboard
val <Error class: unknown class>.isCommonAdministrator: Boolean

Check if receiver object is AdministratorChatMemberImpl

Link copied to clipboard
val <Error class: unknown class>.isCommonMember: Boolean

Check if receiver object is MemberChatMemberImpl

Link copied to clipboard
val <Error class: unknown class>.isKicked: Boolean

Check if receiver object is KickedChatMember

Link copied to clipboard
val <Error class: unknown class>.isKickedOrRestricted: Boolean

Check that member is RestrictedChatMember

Link copied to clipboard
val <Error class: unknown class>.isLeft: Boolean

Check if receiver object is LeftChatMember

Link copied to clipboard
val <Error class: unknown class>.isLeftOrKicked: Boolean

Check if receiver object isLeft or isKicked

Link copied to clipboard
val <Error class: unknown class>.isMember: Boolean

Check if receiver object is MemberChatMember

Link copied to clipboard
val <Error class: unknown class>.isOwner: Boolean

Check if receiver object is OwnerChatMember

Link copied to clipboard
val <Error class: unknown class>.isRestricted: Boolean

Check if receiver object is RestrictedChatMember

Link copied to clipboard
val <Error class: unknown class>.isRestrictedAndNotKicked: Boolean

Check if receiver object isRestricted and not isKicked

Link copied to clipboard
val <Error class: unknown class>.isRestrictedMember: Boolean

Check if receiver object is RestrictedMemberChatMember

Link copied to clipboard
val <Error class: unknown class>.isSpecialRightsMember: Boolean

Check if receiver object is SpecialRightsChatMember

Link copied to clipboard
val <Error class: unknown class>.isSubscriberMember: Boolean

Check if receiver object is SubscriptionMemberChatMember

Link copied to clipboard
val <Error class: unknown class>.joinedChat: Boolean

User joined a chat

Link copied to clipboard
val <Error class: unknown class>.kicked: Boolean

ChatMemberUpdated.newChatMemberState of this

Link copied to clipboard
val <Error class: unknown class>.leftChat: Boolean

Member left a chat for any reason

Link copied to clipboard
val <Error class: unknown class>.subscribed: Boolean

Member became a chat subscriber

Link copied to clipboard
val <Error class: unknown class>.subscriptionUpdated: Boolean

Member became a chat subscriber or renewed their subscription

Link copied to clipboard
val <Error class: unknown class>.unsubscribed: Boolean

Member subscription was expired. User still can be a member

Link copied to clipboard
val <Error class: unknown class>.unsubscribedAndLeft: Boolean

Member subscription was expired and user left the chat

Functions

Link copied to clipboard
suspend fun <Error class: unknown class>.download(telegramAPIUrlsKeeper: <Error class: unknown class>, client: <Error class: unknown class> = HttpClient(defaultKtorEngine)): <Error class: unknown class>
Link copied to clipboard
inline fun <T> Flow<T>.fromChat(chatId: <Error class: unknown class>): Flow<T>

Will pass only those T which have sameChat as chatId

inline fun <T> Flow<T>.fromChat(chat: <Error class: unknown class>): Flow<T>

Will pass only those T which have sameChat as chatId

Link copied to clipboard
inline fun <T> Flow<T>.fromUser(userId: <Error class: unknown class>): Flow<T>
inline fun <T> Flow<T>.fromUser(user: <Error class: unknown class>): Flow<T>
Link copied to clipboard
suspend fun <Error class: unknown class>.loadFile(telegramAPIUrlsKeeper: <Error class: unknown class>, pathedFile: <Error class: unknown class>): <Error class: unknown class>
suspend fun <Error class: unknown class>.loadFile(telegramAPIUrlsKeeper: <Error class: unknown class>, filePath: String): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.parseCommandsWithArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.parseCommandsWithArgs(argsSeparator: String): <Error class: unknown class>
fun <Error class: unknown class>.parseCommandsWithArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): <Error class: unknown class>
fun <Error class: unknown class>.parseCommandsWithArgs(argsSeparator: String): <Error class: unknown class>
fun List<<Error class: unknown class>>.parseCommandsWithArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex): MutableMap<String, Array<String>>
fun List<<Error class: unknown class>>.parseCommandsWithArgs(argsSeparator: String): MutableMap<String, Array<String>>

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

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.parseCommandsWithArgsSources(): <Error class: unknown class>
fun <Error class: unknown class>.parseCommandsWithArgsSources(): <Error class: unknown class>
fun List<<Error class: unknown class>>.parseCommandsWithArgsSources(): Map<<Error class: unknown class>, Array<<Error class: unknown class>>>

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

Link copied to clipboard
fun <Error class: unknown class><<Error class: unknown class>>.parseCommandsWithNamedArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): <Error class: unknown class>
fun <Error class: unknown class><<Error class: unknown class>>.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): <Error class: unknown class>
fun <Error class: unknown class>.parseCommandsWithNamedArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): <Error class: unknown class>
fun <Error class: unknown class>.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): <Error class: unknown class>
fun List<<Error class: unknown class>>.parseCommandsWithNamedArgs(argsSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultArgsSeparatorRegex, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<<Error class: unknown class><String, String>>>
fun List<<Error class: unknown class>>.parseCommandsWithNamedArgs(argsSeparator: String, nameArgSeparator: <Error class: unknown class> = TelegramBotCommandsDefaults.defaultNamesArgsSeparatorRegex): Map<String, List<<Error class: unknown class><String, String>>>

Uses parseCommandsWithArgs to create base argsSeparator split args for commands and map their as k-v pairs. Sample:

Link copied to clipboard
inline fun <Error class: unknown class>.sameBusinessConnection(id: <Error class: unknown class>): Boolean
inline fun <Error class: unknown class>.sameBusinessConnection(other: <Error class: unknown class>): <Error class: unknown class>
Link copied to clipboard
inline fun <Error class: unknown class>.sameChat(chatId: <Error class: unknown class>): Boolean
inline fun <Error class: unknown class>.sameChat(chat: <Error class: unknown class>): Boolean
inline fun <Error class: unknown class>.sameChat(other: <Error class: unknown class>): <Error class: unknown class>
Link copied to clipboard
inline fun <Error class: unknown class>.sameMessage(other: <Error class: unknown class>): <Error class: unknown class>
inline fun <Error class: unknown class>.sameMessage(chatId: <Error class: unknown class>, messageId: <Error class: unknown class>): Boolean
inline fun <Error class: unknown class>.sameMessage(chat: <Error class: unknown class>, messageId: <Error class: unknown class>): Boolean
Link copied to clipboard
inline fun <Error class: unknown class>.sameThread(other: <Error class: unknown class>): <Error class: unknown class>
inline fun <Error class: unknown class>.sameThread(chatId: <Error class: unknown class>, threadId: <Error class: unknown class>? = chatId.threadId): <Error class: unknown class>
inline fun <Error class: unknown class>.sameThread(chat: <Error class: unknown class>, threadId: <Error class: unknown class>? = chat.id.threadId): <Error class: unknown class>

Thread is the same thing that topic

Link copied to clipboard
inline fun <Error class: unknown class>.sameTopic(other: <Error class: unknown class>): <Error class: unknown class>
inline fun <Error class: unknown class>.sameTopic(chatId: <Error class: unknown class>, threadId: <Error class: unknown class>? = chatId.threadId): Boolean
inline fun <Error class: unknown class>.sameTopic(chat: <Error class: unknown class>, threadId: <Error class: unknown class>? = chat.id.threadId): <Error class: unknown class>

Thread is the same thing that topic

Link copied to clipboard
fun <Error class: unknown class>.sourceChat(): Nothing?
fun <Error class: unknown class>.sourceChat(): <Error class: unknown class>?
Link copied to clipboard
fun <Error class: unknown class>.sourceChatWithConverters(baseMessageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, chatJoinRequestUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, shippingQueryUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { null }, pollAnswerUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { null }, preCheckoutQueryUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.from }, callbackQueryUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.sourceChat() }, chosenInlineResultUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { null }, inlineQueryUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { null }, pollUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { null }, channelPostUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, messageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, editChannelPostUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, editMessageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, myChatMemberUpdatedUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, chatMessageReactionUpdatedUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, chatMessageReactionsCountUpdatedUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, chatBoostUpdatedUpdateFlow: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, chatBoostRemovedUpdateFlow: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, businessConnectionUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.user }, businessMessageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, editBusinessMessageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, deleteBusinessMessageUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }, paidMediaPurchasedUpdatesFlowConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.user }, commonChatMemberUpdatedUpdateConverter: (<Error class: unknown class>) -> <Error class: unknown class>? = { it.data.chat }): <Error class: unknown class>?
Link copied to clipboard
fun <Error class: unknown class>.sourceUser(): <Error class: unknown class>?

Trying to get the user from Update. In some cases it can be the user without actual fields like dev.inmo.tgbotapi.types.chat.CommonUser.isPremium due to in these cases will be used toUser cast