CommonForumContentMessageImpl

data class CommonForumContentMessageImpl<T : MessageContent>(val chat: PreviewForumChat, val messageId: MessageId, val threadId: MessageThreadId, val from: User, val date: DateTime, val forwardOrigin: MessageOrigin?, val editDate: DateTime?, val hasProtectedContent: Boolean, val replyInfo: ReplyInfo?, val replyMarkup: InlineKeyboardMarkup?, val content: T, val senderBot: CommonBot?, val guestBotCallerUser: PreviewUser?, val guestBotCallerChat: PreviewChat?, val mediaGroupId: MediaGroupId?, val senderBoostsCount: Int?, val fromOffline: Boolean, val cost: Int? = null, val senderTag: UserTag? = null) : CommonForumContentMessage<T> (source)

Constructors

Link copied to clipboard
constructor(chat: PreviewForumChat, messageId: MessageId, threadId: MessageThreadId, from: User, date: DateTime, forwardOrigin: MessageOrigin?, editDate: DateTime?, hasProtectedContent: Boolean, replyInfo: ReplyInfo?, replyMarkup: InlineKeyboardMarkup?, content: T, senderBot: CommonBot?, guestBotCallerUser: PreviewUser?, guestBotCallerChat: PreviewChat?, mediaGroupId: MediaGroupId?, senderBoostsCount: Int?, fromOffline: Boolean, cost: Int? = null, senderTag: UserTag? = null)
constructor(chat: PreviewForumChat, messageId: MessageId, threadId: MessageThreadId, from: User, date: DateTime, forwardInfo: ForwardInfo, editDate: DateTime?, hasProtectedContent: Boolean, replyTo: AccessibleMessage?, replyMarkup: InlineKeyboardMarkup?, content: T, senderBot: CommonBot?, guestBotCallerUser: PreviewUser?, guestBotCallerChat: PreviewChat?, mediaGroupId: MediaGroupId?, senderBoostsCount: Int?, fromOffline: Boolean, cost: Int? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val chat: PreviewForumChat
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val content: T
Link copied to clipboard
@SerialName(value = "paid_message_star_count")
open override val cost: Int?
Link copied to clipboard
open override val date: DateTime
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val editDate: DateTime?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val forwardOrigin: MessageOrigin?
Link copied to clipboard
open override val from: User

The source User of this type

Link copied to clipboard
Link copied to clipboard
open override val fromOffline: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val guestBotCallerChat: PreviewChat?
Link copied to clipboard
open override val guestBotCallerUser: PreviewUser?
Link copied to clipboard
open override val hasProtectedContent: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val mediaGroupId: MediaGroupId?
Link copied to clipboard
open override val messageId: MessageId
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val replyInfo: ReplyInfo?
Link copied to clipboard
open override val replyMarkup: InlineKeyboardMarkup?
Link copied to clipboard
open val replyTo: Message?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val senderBoostsCount: Int?
Link copied to clipboard
open override val senderBot: CommonBot?
Link copied to clipboard
@SerialName(value = "sender_tag")
open override val senderTag: UserTag?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override val threadId: MessageThreadId
Link copied to clipboard
Link copied to clipboard
open override val user: User
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun AccessibleMessage.delete(requestsExecutor: TelegramBot)
Link copied to clipboard

A predicate to test that message has been sent in the forum. Use it as the initialFilter parameter in behaviour builder triggers. E.g.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A predicate to test whether a message contains any commands in its body. Use it as the initialFilter parameter in behaviour builder triggers. E.g.

Link copied to clipboard

A predicate to test whether a message contains any commands in its body. Use it as the initialFilter parameter in behaviour builder triggers. E.g.

Link copied to clipboard
inline fun <T> Message.ifAccessibleMessage(block: (AccessibleMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifCallbackQuery(block: (CallbackQuery) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifChatMember(block: (ChatMember) -> T): T?
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.ifChatMessage(block: (ChatMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifFromUser(block: (FromUser) -> T): T?
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.ifFromUserMessage(block: (FromUserMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifInlineQuery(block: (InlineQuery) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.ifPassportMessage(block: (PassportMessage) -> T): T?
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifPollAnswer(block: (PollAnswer) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifShippingQuery(block: (ShippingQuery) -> T): T?
Link copied to clipboard
inline fun <T> Message.ifSignedMessage(block: (SignedMessage) -> T): T?
Link copied to clipboard
inline fun <T> Message.ifSpecialMessage(block: (SpecialMessage) -> T): T?
Link copied to clipboard
inline fun <T> Message.ifUnknownMessageType(block: (UnknownMessageType) -> T): T?
Link copied to clipboard
inline fun <T> OptionallyWithUser.ifWithUser(block: (WithUser) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Uses isWithMention with user (is presented) or isWithTextMention with user to determine user mentioning in this

Link copied to clipboard

A predicate to test that message has not been sent in the forum. Use it as the initialFilter parameter in behaviour builder triggers. E.g.

Link copied to clipboard
fun ContentMessage<TextContent>.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

Link copied to clipboard

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

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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
Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.whenFromUserMessage(block: (FromUserMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.whenPassportMessage(block: (PassportMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> Message.whenSignedMessage(block: (SignedMessage) -> T): T?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard