docs/dev.inmo.tgbotapi.types.message.abstracts/AnonymousForumContentMessage

AnonymousForumContentMessage

interface AnonymousForumContentMessage<T : MessageContent> : ForumContentMessage<T> , SignedMessage, WithSenderChatMessage(source)

Inheritors

AnonymousForumContentMessageImpl

Properties

val Message.animation: AnimationFile?

val Message.audio: AudioFile?

author_signature

val Message.author_signature: AuthorSignature?

authorSignature

abstract val authorSignature: AuthorSignature?

businessConnectionId

open override val businessConnectionId: BusinessConnectionId?

val Message.caption: String?

caption_entities

val Message.caption_entities: TextSourcesList?

channel_chat_created

val Message.channel_chat_created: Boolean

abstract override val chat: PreviewForumChat

connected_website

val Message.connected_website: String?

val Message.contact: Contact?

abstract val content: T

abstract val cost: Int?

abstract val date: DateTime

delete_chat_photo

val Message.delete_chat_photo: Boolean

val Message.dice: Dice?

directMessageThreadIdOrNull

val Message.directMessageThreadIdOrNull: DirectMessageThreadId?

val Message.document: DocumentFile?

val Message.edit_date: TelegramDate?

abstract val editDate: DateTime?

val Message.entities: TextSourcesList?

val Message.forward_date: TelegramDate?

val Message.forward_from: User?

forward_from_chat

val Message.forward_from_chat: Chat?

forward_from_message_id

val Message.forward_from_message_id: MessageId?

forward_sender_name

val Message.forward_sender_name: ForwardSenderName?

forward_signature

val Message.forward_signature: ForwardSignature?

open val forwardable: Boolean

open val forwardInfo: ForwardInfo?

abstract val forwardOrigin: MessageOrigin?

val Message.from: User?

abstract val fromOffline: Boolean

val Message.game: Game?

group_chat_created

val Message.group_chat_created: Boolean

guest_bot_caller_chat

val Message.guest_bot_caller_chat: PreviewChat?

guest_bot_caller_user

val Message.guest_bot_caller_user: PreviewUser?

has_protected_content

val Message.has_protected_content: Boolean?

hasProtectedContent

abstract val hasProtectedContent: Boolean

val Message.invoice: Invoice?

is_automatic_forward

val Message.is_automatic_forward: Boolean?

left_chat_member

val Message.left_chat_member: User?

val Message.location: Location?

val Message.media_group_id: MediaGroupId?

abstract val mediaGroupId: MediaGroupId?

message_auto_delete_timer_changed

val Message.message_auto_delete_timer_changed: MessageAutoDeleteTimerChanged?

abstract val messageId: MessageId

val Message.messageLink: String?

open val metaInfo: Message.MetaInfo

migrate_from_chat_id

val Message.migrate_from_chat_id: IdChatIdentifier?

migrate_to_chat_id

val Message.migrate_to_chat_id: IdChatIdentifier?

new_chat_members

val Message.new_chat_members: List<User>?

val Message.new_chat_photo: PhotoFile?

val Message.new_chat_title: String?

val Message.passport_data: PassportData?

val Message.photo: PhotoFile?

val Message.pinned_message: Message?

val Message.poll: Poll?

proximity_alert_triggered

val Message.proximity_alert_triggered: ProximityAlertTriggered?

val Message.reply_markup: InlineKeyboardMarkup?

reply_to_message

val Message.reply_to_message: Message?

abstract val replyInfo: ReplyInfo?

abstract val replyMarkup: InlineKeyboardMarkup?

open val replyTo: Message?

val Message.sender_chat: PreviewChat?

val Message.sender_tag: UserTag?

abstract val senderBot: CommonBot?

open override val senderChat: PreviewGroupChat

val Message.sticker: Sticker?

successful_payment

val Message.successful_payment: SuccessfulPayment?

supergroup_chat_created

val Message.supergroup_chat_created: Boolean

val Message.text: String?

threadCreatingInfo

open override val threadCreatingInfo: ForumTopicCreated?

abstract override val threadId: MessageThreadId

val Message.threadIdOrNull: MessageThreadId?

val Message.venue: Venue?

val Message.via_bot: CommonBot?

val Message.video: VideoFile?

video_chat_ended

val Message.video_chat_ended: VideoChatEnded?

video_chat_participants_invited

val Message.video_chat_participants_invited: VideoChatParticipantsInvited?

video_chat_scheduled

val Message.video_chat_scheduled: VideoChatScheduled?

video_chat_started

val Message.video_chat_started: VideoChatStarted?

val Message.video_note: VideoNoteFile?

val Message.voice: VoiceFile?

Functions

accessibleMessageOrNull

inline fun Message.accessibleMessageOrNull(): AccessibleMessage?

accessibleMessageOrThrow

inline fun Message.accessibleMessageOrThrow(): AccessibleMessage

anonymousForumContentMessageOrNull

inline fun Message.anonymousForumContentMessageOrNull(): AnonymousForumContentMessage<MessageContent>?

anonymousForumContentMessageOrThrow

inline fun Message.anonymousForumContentMessageOrThrow(): AnonymousForumContentMessage<MessageContent>

anonymousGroupContentMessageOrNull

inline fun Message.anonymousGroupContentMessageOrNull(): AnonymousGroupContentMessage<MessageContent>?

anonymousGroupContentMessageOrThrow

inline fun Message.anonymousGroupContentMessageOrThrow(): AnonymousGroupContentMessage<MessageContent>

asAnonymousGroupContentMessage

inline fun Message.asAnonymousGroupContentMessage(): AnonymousGroupContentMessage<MessageContent>?

asAnonymousGroupContentMessageImpl

inline fun Message.asAnonymousGroupContentMessageImpl(): AnonymousGroupContentMessageImpl<MessageContent>?

asChannelContentMessage

inline fun Message.asChannelContentMessage(): ChannelContentMessage<MessageContent>?

asChannelContentMessageImpl

inline fun Message.asChannelContentMessageImpl(): UnconnectedFromChannelGroupContentMessageImpl<MessageContent>?

asChannelEventMessage

inline fun Message.asChannelEventMessage(): ChannelEventMessage<ChannelEvent>?

asChatEventMessage

inline fun Message.asChatEventMessage(): ChatEventMessage<ChatEvent>?

asCommonGroupContentMessage

inline fun Message.asCommonGroupContentMessage(): CommonGroupContentMessage<MessageContent>?

asCommonGroupEventMessage

inline fun Message.asCommonGroupEventMessage(): CommonGroupEventMessage<GroupEvent>?

asCommonMessage

inline fun Message.asCommonMessage(): ChatContentMessage<MessageContent>?

asCommonSupergroupEventMessage

inline fun Message.asCommonSupergroupEventMessage(): CommonSupergroupEventMessage<SupergroupEvent>?

asConnectedFromChannelGroupContentMessage

inline fun Message.asConnectedFromChannelGroupContentMessage(): ConnectedFromChannelGroupContentMessage<MessageContent>?

asContentMessage

inline fun Message.asContentMessage(): ContentMessage<MessageContent>?

asFromChannelGroupContentMessage

inline fun Message.asFromChannelGroupContentMessage(): FromChannelGroupContentMessage<MessageContent>?

asFromUserMessage

inline fun Message.asFromUserMessage(): FromUserMessage?

asGroupContentMessage

inline fun Message.asGroupContentMessage(): GroupContentMessage<MessageContent>?

asGroupEventMessage

inline fun Message.asGroupEventMessage(): GroupEventMessage<GroupEvent>?

asMediaGroupMessage

inline fun Message.asMediaGroupMessage(): MediaGroupMessage<MediaGroupPartContent>?

asPassportMessage

inline fun Message.asPassportMessage(): PassportMessage?

asPossiblyEditedMessage

inline fun Message.asPossiblyEditedMessage(): PossiblyEditedMessage?

asPossiblyForwardedMessage

inline fun Message.asPossiblyForwardedMessage(): PossiblyForwardedMessage?

asPossiblyPaymentMessage

inline fun Message.asPossiblyPaymentMessage(): PossiblyPaymentMessage?

asPossiblyReplyMessage

inline fun Message.asPossiblyReplyMessage(): PossiblyReplyMessage?

asPossiblySentViaBotCommonMessage

inline fun Message.asPossiblySentViaBotCommonMessage(): PossiblySentViaBotCommonMessage<MessageContent>?

asPrivateContentMessage

inline fun Message.asPrivateContentMessage(): PrivateContentMessage<MessageContent>?

asPrivateContentMessageImpl

inline fun Message.asPrivateContentMessageImpl(): PrivateContentMessageImpl<MessageContent>?

asPrivateEventMessage

inline fun Message.asPrivateEventMessage(): PrivateEventMessage<PrivateEvent>?

asPublicContentMessage

inline fun Message.asPublicContentMessage(): PublicContentMessage<MessageContent>?

asSignedMessage

inline fun Message.asSignedMessage(): SignedMessage?

asSupergroupEventMessage

inline fun Message.asSupergroupEventMessage(): SupergroupEventMessage<SupergroupEvent>?

asUnconnectedFromChannelGroupContentMessage

inline fun Message.asUnconnectedFromChannelGroupContentMessage(): UnconnectedFromChannelGroupContentMessage<MessageContent>?

asUnknownMessageType

inline fun Message.asUnknownMessageType(): UnknownMessageType?

businessContentMessageOrNull

inline fun Message.businessContentMessageOrNull(): BusinessContentMessage<MessageContent>?

businessContentMessageOrThrow

inline fun Message.businessContentMessageOrThrow(): BusinessContentMessage<MessageContent>

channelContentMessageOrNull

inline fun Message.channelContentMessageOrNull(): ChannelContentMessage<MessageContent>?

channelContentMessageOrThrow

inline fun Message.channelContentMessageOrThrow(): ChannelContentMessage<MessageContent>

channelDirectMessagesContentMessageOrNull

inline fun Message.channelDirectMessagesContentMessageOrNull(): ChannelDirectMessagesContentMessage<MessageContent>?

channelDirectMessagesContentMessageOrThrow

inline fun Message.channelDirectMessagesContentMessageOrThrow(): ChannelDirectMessagesContentMessage<MessageContent>

channelDirectMessagesEventMessageOrNull

inline fun Message.channelDirectMessagesEventMessageOrNull(): ChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>?

channelDirectMessagesEventMessageOrThrow

inline fun Message.channelDirectMessagesEventMessageOrThrow(): ChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>

channelEventMessageOrNull

inline fun Message.channelEventMessageOrNull(): ChannelEventMessage<ChannelEvent>?

channelEventMessageOrThrow

inline fun Message.channelEventMessageOrThrow(): ChannelEventMessage<ChannelEvent>

channelPaidPostOrNull

inline fun Message.channelPaidPostOrNull(): ChannelPaidPost<MessageContent>?

channelPaidPostOrThrow

inline fun Message.channelPaidPostOrThrow(): ChannelPaidPost<MessageContent>

chatContentMessageOrNull

inline fun Message.chatContentMessageOrNull(): ChatContentMessage<MessageContent>?

chatContentMessageOrThrow

inline fun Message.chatContentMessageOrThrow(): ChatContentMessage<MessageContent>

chatEventMessageOrNull

inline fun Message.chatEventMessageOrNull(): ChatEventMessage<ChatEvent>?

chatEventMessageOrThrow

inline fun Message.chatEventMessageOrThrow(): ChatEventMessage<ChatEvent>

chatMessageOrNull

inline fun Message.chatMessageOrNull(): ChatMessage?

chatMessageOrThrow

inline fun Message.chatMessageOrThrow(): ChatMessage

commonChannelDirectMessagesContentMessageOrNull

inline fun Message.commonChannelDirectMessagesContentMessageOrNull(): CommonChannelDirectMessagesContentMessage<MessageContent>?

commonChannelDirectMessagesContentMessageOrThrow

inline fun Message.commonChannelDirectMessagesContentMessageOrThrow(): CommonChannelDirectMessagesContentMessage<MessageContent>

commonChannelDirectMessagesEventMessageOrNull

inline fun Message.commonChannelDirectMessagesEventMessageOrNull(): CommonChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>?

commonChannelDirectMessagesEventMessageOrThrow

inline fun Message.commonChannelDirectMessagesEventMessageOrThrow(): CommonChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>

commonContentMessageOrNull

inline fun Message.commonContentMessageOrNull(): CommonContentMessage<MessageContent>?

commonContentMessageOrThrow

inline fun Message.commonContentMessageOrThrow(): CommonContentMessage<MessageContent>

commonForumContentMessageOrNull

inline fun Message.commonForumContentMessageOrNull(): CommonForumContentMessage<MessageContent>?

commonForumContentMessageOrThrow

inline fun Message.commonForumContentMessageOrThrow(): CommonForumContentMessage<MessageContent>

commonGroupContentMessageOrNull

inline fun Message.commonGroupContentMessageOrNull(): CommonGroupContentMessage<MessageContent>?

commonGroupContentMessageOrThrow

inline fun Message.commonGroupContentMessageOrThrow(): CommonGroupContentMessage<MessageContent>

commonGroupEventMessageOrNull

inline fun Message.commonGroupEventMessageOrNull(): CommonGroupEventMessage<GroupEvent>?

commonGroupEventMessageOrThrow

inline fun Message.commonGroupEventMessageOrThrow(): CommonGroupEventMessage<GroupEvent>

commonSuggestedChannelDirectMessagesContentMessageOrNull

inline fun Message.commonSuggestedChannelDirectMessagesContentMessageOrNull(): CommonSuggestedChannelDirectMessagesContentMessage<MessageContent>?

commonSuggestedChannelDirectMessagesContentMessageOrThrow

inline fun Message.commonSuggestedChannelDirectMessagesContentMessageOrThrow(): CommonSuggestedChannelDirectMessagesContentMessage<MessageContent>

commonSupergroupEventMessageOrNull

inline fun Message.commonSupergroupEventMessageOrNull(): CommonSupergroupEventMessage<SupergroupEvent>?

commonSupergroupEventMessageOrThrow

inline fun Message.commonSupergroupEventMessageOrThrow(): CommonSupergroupEventMessage<SupergroupEvent>

connectedFromChannelGroupContentMessageOrNull

inline fun Message.connectedFromChannelGroupContentMessageOrNull(): ConnectedFromChannelGroupContentMessage<MessageContent>?

connectedFromChannelGroupContentMessageOrThrow

inline fun Message.connectedFromChannelGroupContentMessageOrThrow(): ConnectedFromChannelGroupContentMessage<MessageContent>

contentMessageOrNull

inline fun Message.contentMessageOrNull(): ContentMessage<MessageContent>?

contentMessageOrThrow

inline fun Message.contentMessageOrThrow(): ContentMessage<MessageContent>

suspend fun AccessibleMessage.delete(requestsExecutor: TelegramBot)

forumContentMessageOrNull

inline fun Message.forumContentMessageOrNull(): ForumContentMessage<MessageContent>?

forumContentMessageOrThrow

inline fun Message.forumContentMessageOrThrow(): ForumContentMessage<MessageContent>

fun Message.forumMessage(): Boolean

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

fromChannelChannelDirectMessagesContentMessageOrNull

inline fun Message.fromChannelChannelDirectMessagesContentMessageOrNull(): FromChannelChannelDirectMessagesContentMessage<MessageContent>?

fromChannelChannelDirectMessagesContentMessageOrThrow

inline fun Message.fromChannelChannelDirectMessagesContentMessageOrThrow(): FromChannelChannelDirectMessagesContentMessage<MessageContent>

fromChannelForumContentMessageOrNull

inline fun Message.fromChannelForumContentMessageOrNull(): FromChannelForumContentMessage<MessageContent>?

fromChannelForumContentMessageOrThrow

inline fun Message.fromChannelForumContentMessageOrThrow(): FromChannelForumContentMessage<MessageContent>

fromChannelGroupContentMessageOrNull

inline fun Message.fromChannelGroupContentMessageOrNull(): FromChannelGroupContentMessage<MessageContent>?

fromChannelGroupContentMessageOrThrow

inline fun Message.fromChannelGroupContentMessageOrThrow(): FromChannelGroupContentMessage<MessageContent>

fromChannelSuggestedChannelDirectMessagesContentMessageOrNull

inline fun Message.fromChannelSuggestedChannelDirectMessagesContentMessageOrNull(): FromChannelSuggestedChannelDirectMessagesContentMessage<MessageContent>?

fromChannelSuggestedChannelDirectMessagesContentMessageOrThrow

inline fun Message.fromChannelSuggestedChannelDirectMessagesContentMessageOrThrow(): FromChannelSuggestedChannelDirectMessagesContentMessage<MessageContent>

fromUserChatMessageOrNull

inline fun Message.fromUserChatMessageOrNull(): FromUserChatMessage?

fromUserChatMessageOrThrow

inline fun Message.fromUserChatMessageOrThrow(): FromUserChatMessage

fromUserMessageOrNull

inline fun Message.fromUserMessageOrNull(): FromUserMessage?

fromUserMessageOrThrow

inline fun Message.fromUserMessageOrThrow(): FromUserMessage

groupContentMessageOrNull

inline fun Message.groupContentMessageOrNull(): GroupContentMessage<MessageContent>?

groupContentMessageOrThrow

inline fun Message.groupContentMessageOrThrow(): GroupContentMessage<MessageContent>

groupEventMessageOrNull

inline fun Message.groupEventMessageOrNull(): GroupEventMessage<GroupEvent>?

groupEventMessageOrThrow

inline fun Message.groupEventMessageOrThrow(): GroupEventMessage<GroupEvent>

fun ChatContentMessage<*>.hasCommands(): Boolean

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.

fun ChatContentMessage<*>.hasNoCommands(): Boolean

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.

ifAccessibleMessage

inline fun <T> Message.ifAccessibleMessage(block: (AccessibleMessage) -> T): T?

ifAnonymousForumContentMessage

inline fun <T> Message.ifAnonymousForumContentMessage(block: (AnonymousForumContentMessage<MessageContent>) -> T): T?

ifAnonymousGroupContentMessage

inline fun <T> Message.ifAnonymousGroupContentMessage(block: (AnonymousGroupContentMessage<MessageContent>) -> T): T?

ifBusinessContentMessage

inline fun <T> Message.ifBusinessContentMessage(block: (BusinessContentMessage<MessageContent>) -> T): T?

ifChannelContentMessage

inline fun <T> Message.ifChannelContentMessage(block: (ChannelContentMessage<MessageContent>) -> T): T?

ifChannelDirectMessagesContentMessage

inline fun <T> Message.ifChannelDirectMessagesContentMessage(block: (ChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifChannelDirectMessagesEventMessage

inline fun <T> Message.ifChannelDirectMessagesEventMessage(block: (ChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>) -> T): T?

ifChannelEventMessage

inline fun <T> Message.ifChannelEventMessage(block: (ChannelEventMessage<ChannelEvent>) -> T): T?

ifChannelPaidPost

inline fun <T> Message.ifChannelPaidPost(block: (ChannelPaidPost<MessageContent>) -> T): T?

ifChatContentMessage

inline fun <T> Message.ifChatContentMessage(block: (ChatContentMessage<MessageContent>) -> T): T?

ifChatEventMessage

inline fun <T> Message.ifChatEventMessage(block: (ChatEventMessage<ChatEvent>) -> T): T?

inline fun <T> Message.ifChatMessage(block: (ChatMessage) -> T): T?

ifCommonChannelDirectMessagesContentMessage

inline fun <T> Message.ifCommonChannelDirectMessagesContentMessage(block: (CommonChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifCommonChannelDirectMessagesEventMessage

inline fun <T> Message.ifCommonChannelDirectMessagesEventMessage(block: (CommonChannelDirectMessagesEventMessage<ChannelDirectMessagesEvent>) -> T): T?

ifCommonContentMessage

inline fun <T> Message.ifCommonContentMessage(block: (CommonContentMessage<MessageContent>) -> T): T?

ifCommonForumContentMessage

inline fun <T> Message.ifCommonForumContentMessage(block: (CommonForumContentMessage<MessageContent>) -> T): T?

ifCommonGroupContentMessage

inline fun <T> Message.ifCommonGroupContentMessage(block: (CommonGroupContentMessage<MessageContent>) -> T): T?

ifCommonGroupEventMessage

inline fun <T> Message.ifCommonGroupEventMessage(block: (CommonGroupEventMessage<GroupEvent>) -> T): T?

ifCommonSuggestedChannelDirectMessagesContentMessage

inline fun <T> Message.ifCommonSuggestedChannelDirectMessagesContentMessage(block: (CommonSuggestedChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifCommonSupergroupEventMessage

inline fun <T> Message.ifCommonSupergroupEventMessage(block: (CommonSupergroupEventMessage<SupergroupEvent>) -> T): T?

ifConnectedFromChannelGroupContentMessage

inline fun <T> Message.ifConnectedFromChannelGroupContentMessage(block: (ConnectedFromChannelGroupContentMessage<MessageContent>) -> T): T?

ifContentMessage

inline fun <T> Message.ifContentMessage(block: (ContentMessage<MessageContent>) -> T): T?

ifForumContentMessage

inline fun <T> Message.ifForumContentMessage(block: (ForumContentMessage<MessageContent>) -> T): T?

ifFromChannelChannelDirectMessagesContentMessage

inline fun <T> Message.ifFromChannelChannelDirectMessagesContentMessage(block: (FromChannelChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifFromChannelForumContentMessage

inline fun <T> Message.ifFromChannelForumContentMessage(block: (FromChannelForumContentMessage<MessageContent>) -> T): T?

ifFromChannelGroupContentMessage

inline fun <T> Message.ifFromChannelGroupContentMessage(block: (FromChannelGroupContentMessage<MessageContent>) -> T): T?

ifFromChannelSuggestedChannelDirectMessagesContentMessage

inline fun <T> Message.ifFromChannelSuggestedChannelDirectMessagesContentMessage(block: (FromChannelSuggestedChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifFromUserChatMessage

inline fun <T> Message.ifFromUserChatMessage(block: (FromUserChatMessage) -> T): T?

ifFromUserMessage

inline fun <T> Message.ifFromUserMessage(block: (FromUserMessage) -> T): T?

ifGroupContentMessage

inline fun <T> Message.ifGroupContentMessage(block: (GroupContentMessage<MessageContent>) -> T): T?

ifGroupEventMessage

inline fun <T> Message.ifGroupEventMessage(block: (GroupEventMessage<GroupEvent>) -> T): T?

ifInaccessibleMessage

inline fun <T> Message.ifInaccessibleMessage(block: (InaccessibleMessage) -> T): T?

ifOptionallyFromUserMessage

inline fun <T> Message.ifOptionallyFromUserMessage(block: (OptionallyFromUserMessage) -> T): T?

ifPassportMessage

inline fun <T> Message.ifPassportMessage(block: (PassportMessage) -> T): T?

ifPossiblyEditedMessage

inline fun <T> Message.ifPossiblyEditedMessage(block: (PossiblyEditedMessage) -> T): T?

ifPossiblyForwardedMessage

inline fun <T> Message.ifPossiblyForwardedMessage(block: (PossiblyForwardedMessage) -> T): T?

ifPossiblyGuestAnswerMessage

inline fun <T> Message.ifPossiblyGuestAnswerMessage(block: (PossiblyGuestAnswerMessage) -> T): T?

ifPossiblyMediaGroupMessage

inline fun <T> Message.ifPossiblyMediaGroupMessage(block: (PossiblyMediaGroupMessage<MessageContent>) -> T): T?

ifPossiblyOfflineMessage

inline fun <T> Message.ifPossiblyOfflineMessage(block: (PossiblyOfflineMessage) -> T): T?

ifPossiblyPaidMessage

inline fun <T> Message.ifPossiblyPaidMessage(block: (PossiblyPaidMessage) -> T): T?

ifPossiblyPaymentMessage

inline fun <T> Message.ifPossiblyPaymentMessage(block: (PossiblyPaymentMessage) -> T): T?

ifPossiblySentViaBotCommonMessage

inline fun <T> Message.ifPossiblySentViaBotCommonMessage(block: (PossiblySentViaBotCommonMessage<MessageContent>) -> T): T?

ifPossiblyTopicMessage

inline fun <T> Message.ifPossiblyTopicMessage(block: (PossiblyTopicMessage) -> T): T?

ifPossiblyWithEffectMessage

inline fun <T> Message.ifPossiblyWithEffectMessage(block: (PossiblyWithEffectMessage) -> T): T?

ifPotentiallyFromUserGroupContentMessage

inline fun <T> Message.ifPotentiallyFromUserGroupContentMessage(block: (PotentiallyFromUserGroupContentMessage<MessageContent>) -> T): T?

ifPrivateContentMessage

inline fun <T> Message.ifPrivateContentMessage(block: (PrivateContentMessage<MessageContent>) -> T): T?

ifPrivateEventMessage

inline fun <T> Message.ifPrivateEventMessage(block: (PrivateEventMessage<PrivateEvent>) -> T): T?

ifPrivateForumContentMessage

inline fun <T> Message.ifPrivateForumContentMessage(block: (PrivateForumContentMessage<MessageContent>) -> T): T?

ifPrivateForumEventMessage

inline fun <T> Message.ifPrivateForumEventMessage(block: (PrivateForumEventMessage<PrivateForumEvent>) -> T): T?

ifPublicContentMessage

inline fun <T> Message.ifPublicContentMessage(block: (PublicContentMessage<MessageContent>) -> T): T?

ifRequestGuestContentMessage

inline fun <T> Message.ifRequestGuestContentMessage(block: (RequestGuestContentMessage<MessageContent>) -> T): T?

ifRequestGuestMessage

inline fun <T> Message.ifRequestGuestMessage(block: (RequestGuestMessage) -> T): T?

ifSignedMessage

inline fun <T> Message.ifSignedMessage(block: (SignedMessage) -> T): T?

ifSpecialMessage

inline fun <T> Message.ifSpecialMessage(block: (SpecialMessage) -> T): T?

ifSuggestedChannelDirectMessagesContentMessage

inline fun <T> Message.ifSuggestedChannelDirectMessagesContentMessage(block: (SuggestedChannelDirectMessagesContentMessage<MessageContent>) -> T): T?

ifSupergroupEventMessage

inline fun <T> Message.ifSupergroupEventMessage(block: (SupergroupEventMessage<SupergroupEvent>) -> T): T?

ifUnconnectedFromChannelGroupContentMessage

inline fun <T> Message.ifUnconnectedFromChannelGroupContentMessage(block: (UnconnectedFromChannelGroupContentMessage<MessageContent>) -> T): T?

ifUnknownMessageType

inline fun <T> Message.ifUnknownMessageType(block: (UnknownMessageType) -> T): T?

inaccessibleMessageOrNull

inline fun Message.inaccessibleMessageOrNull(): InaccessibleMessage?

inaccessibleMessageOrThrow

inline fun Message.inaccessibleMessageOrThrow(): InaccessibleMessage

fun ChatContentMessage<TextedContent>.isWithMention(username: Username): Boolean

fun ChatContentMessage<TextedContent>.isWithMention(user: User): Boolean

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

isWithTextMention

fun ChatContentMessage<TextedContent>.isWithTextMention(userId: UserId): Boolean

notForumMessage

fun Message.notForumMessage(): Boolean

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.

optionallyFromUserMessageOrNull

inline fun Message.optionallyFromUserMessageOrNull(): OptionallyFromUserMessage?

optionallyFromUserMessageOrThrow

inline fun Message.optionallyFromUserMessageOrThrow(): OptionallyFromUserMessage

parseCommandsWithArgs

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

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

parseCommandsWithArgsSources

fun ContentMessage<TextContent>.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 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:

passportMessageOrNull

inline fun Message.passportMessageOrNull(): PassportMessage?

passportMessageOrThrow

inline fun Message.passportMessageOrThrow(): PassportMessage

possiblyEditedMessageOrNull

inline fun Message.possiblyEditedMessageOrNull(): PossiblyEditedMessage?

possiblyEditedMessageOrThrow

inline fun Message.possiblyEditedMessageOrThrow(): PossiblyEditedMessage

possiblyForwardedMessageOrNull

inline fun Message.possiblyForwardedMessageOrNull(): PossiblyForwardedMessage?

possiblyForwardedMessageOrThrow

inline fun Message.possiblyForwardedMessageOrThrow(): PossiblyForwardedMessage

possiblyGuestAnswerMessageOrNull

inline fun Message.possiblyGuestAnswerMessageOrNull(): PossiblyGuestAnswerMessage?

possiblyGuestAnswerMessageOrThrow

inline fun Message.possiblyGuestAnswerMessageOrThrow(): PossiblyGuestAnswerMessage

possiblyMediaGroupMessageOrNull

inline fun Message.possiblyMediaGroupMessageOrNull(): PossiblyMediaGroupMessage<MessageContent>?

possiblyMediaGroupMessageOrThrow

inline fun Message.possiblyMediaGroupMessageOrThrow(): PossiblyMediaGroupMessage<MessageContent>

possiblyOfflineMessageOrNull

inline fun Message.possiblyOfflineMessageOrNull(): PossiblyOfflineMessage?

possiblyOfflineMessageOrThrow

inline fun Message.possiblyOfflineMessageOrThrow(): PossiblyOfflineMessage

possiblyPaidMessageOrNull

inline fun Message.possiblyPaidMessageOrNull(): PossiblyPaidMessage?

possiblyPaidMessageOrThrow

inline fun Message.possiblyPaidMessageOrThrow(): PossiblyPaidMessage

possiblyPaymentMessageOrNull

inline fun Message.possiblyPaymentMessageOrNull(): PossiblyPaymentMessage?

possiblyPaymentMessageOrThrow

inline fun Message.possiblyPaymentMessageOrThrow(): PossiblyPaymentMessage

possiblySentViaBotCommonMessageOrNull

inline fun Message.possiblySentViaBotCommonMessageOrNull(): PossiblySentViaBotCommonMessage<MessageContent>?

possiblySentViaBotCommonMessageOrThrow

inline fun Message.possiblySentViaBotCommonMessageOrThrow(): PossiblySentViaBotCommonMessage<MessageContent>

possiblyTopicMessageOrNull

inline fun Message.possiblyTopicMessageOrNull(): PossiblyTopicMessage?

possiblyTopicMessageOrThrow

inline fun Message.possiblyTopicMessageOrThrow(): PossiblyTopicMessage

possiblyWithEffectMessageOrNull

inline fun Message.possiblyWithEffectMessageOrNull(): PossiblyWithEffectMessage?

possiblyWithEffectMessageOrThrow

inline fun Message.possiblyWithEffectMessageOrThrow(): PossiblyWithEffectMessage

potentiallyFromUserGroupContentMessageOrNull

inline fun Message.potentiallyFromUserGroupContentMessageOrNull(): PotentiallyFromUserGroupContentMessage<MessageContent>?

potentiallyFromUserGroupContentMessageOrThrow

inline fun Message.potentiallyFromUserGroupContentMessageOrThrow(): PotentiallyFromUserGroupContentMessage<MessageContent>

privateContentMessageOrNull

inline fun Message.privateContentMessageOrNull(): PrivateContentMessage<MessageContent>?

privateContentMessageOrThrow

inline fun Message.privateContentMessageOrThrow(): PrivateContentMessage<MessageContent>

privateEventMessageOrNull

inline fun Message.privateEventMessageOrNull(): PrivateEventMessage<PrivateEvent>?

privateEventMessageOrThrow

inline fun Message.privateEventMessageOrThrow(): PrivateEventMessage<PrivateEvent>

privateForumContentMessageOrNull

inline fun Message.privateForumContentMessageOrNull(): PrivateForumContentMessage<MessageContent>?

privateForumContentMessageOrThrow

inline fun Message.privateForumContentMessageOrThrow(): PrivateForumContentMessage<MessageContent>

privateForumEventMessageOrNull

inline fun Message.privateForumEventMessageOrNull(): PrivateForumEventMessage<PrivateForumEvent>?

privateForumEventMessageOrThrow

inline fun Message.privateForumEventMessageOrThrow(): PrivateForumEventMessage<PrivateForumEvent>

publicContentMessageOrNull

inline fun Message.publicContentMessageOrNull(): PublicContentMessage<MessageContent>?

publicContentMessageOrThrow

inline fun Message.publicContentMessageOrThrow(): PublicContentMessage<MessageContent>

requestGuestContentMessageOrNull

inline fun Message.requestGuestContentMessageOrNull(): RequestGuestContentMessage<MessageContent>?

requestGuestContentMessageOrThrow

inline fun Message.requestGuestContentMessageOrThrow(): RequestGuestContentMessage<MessageContent>

requestGuestMessageOrNull

inline fun Message.requestGuestMessageOrNull(): RequestGuestMessage?

requestGuestMessageOrThrow

inline fun Message.requestGuestMessageOrThrow(): RequestGuestMessage

requireAnonymousGroupContentMessage

inline fun Message.requireAnonymousGroupContentMessage(): AnonymousGroupContentMessage<MessageContent>

requireAnonymousGroupContentMessageImpl

inline fun Message.requireAnonymousGroupContentMessageImpl(): AnonymousGroupContentMessageImpl<MessageContent>

requireChannelContentMessage

inline fun Message.requireChannelContentMessage(): ChannelContentMessage<MessageContent>

requireChannelContentMessageImpl

inline fun Message.requireChannelContentMessageImpl(): UnconnectedFromChannelGroupContentMessageImpl<MessageContent>

requireChannelEventMessage

inline fun Message.requireChannelEventMessage(): ChannelEventMessage<ChannelEvent>

requireChatEventMessage

inline fun Message.requireChatEventMessage(): ChatEventMessage<ChatEvent>

requireCommonGroupContentMessage

inline fun Message.requireCommonGroupContentMessage(): CommonGroupContentMessage<MessageContent>

requireCommonGroupEventMessage

inline fun Message.requireCommonGroupEventMessage(): CommonGroupEventMessage<GroupEvent>

requireCommonMessage

inline fun Message.requireCommonMessage(): ChatContentMessage<MessageContent>

requireCommonSupergroupEventMessage

inline fun Message.requireCommonSupergroupEventMessage(): CommonSupergroupEventMessage<SupergroupEvent>

requireConnectedFromChannelGroupContentMessage

inline fun Message.requireConnectedFromChannelGroupContentMessage(): ConnectedFromChannelGroupContentMessage<MessageContent>

requireContentMessage

inline fun Message.requireContentMessage(): ContentMessage<MessageContent>

requireFromChannelGroupContentMessage

inline fun Message.requireFromChannelGroupContentMessage(): FromChannelGroupContentMessage<MessageContent>

requireFromUserMessage

inline fun Message.requireFromUserMessage(): FromUserMessage

requireGroupContentMessage

inline fun Message.requireGroupContentMessage(): GroupContentMessage<MessageContent>

requireGroupEventMessage

inline fun Message.requireGroupEventMessage(): GroupEventMessage<GroupEvent>

requireMediaGroupMessage

inline fun Message.requireMediaGroupMessage(): MediaGroupMessage<MediaGroupPartContent>

requirePassportMessage

inline fun Message.requirePassportMessage(): PassportMessage

requirePossiblyEditedMessage

inline fun Message.requirePossiblyEditedMessage(): PossiblyEditedMessage

requirePossiblyForwardedMessage

inline fun Message.requirePossiblyForwardedMessage(): PossiblyForwardedMessage

requirePossiblyPaymentMessage

inline fun Message.requirePossiblyPaymentMessage(): PossiblyPaymentMessage

requirePossiblyReplyMessage

inline fun Message.requirePossiblyReplyMessage(): PossiblyReplyMessage

requirePossiblySentViaBotCommonMessage

inline fun Message.requirePossiblySentViaBotCommonMessage(): PossiblySentViaBotCommonMessage<MessageContent>

requirePrivateContentMessage

inline fun Message.requirePrivateContentMessage(): PrivateContentMessage<MessageContent>

requirePrivateContentMessageImpl

inline fun Message.requirePrivateContentMessageImpl(): PrivateContentMessageImpl<MessageContent>

requirePrivateEventMessage

inline fun Message.requirePrivateEventMessage(): PrivateEventMessage<PrivateEvent>

requirePublicContentMessage

inline fun Message.requirePublicContentMessage(): PublicContentMessage<MessageContent>

requireSignedMessage

inline fun Message.requireSignedMessage(): SignedMessage

requireSupergroupEventMessage

inline fun Message.requireSupergroupEventMessage(): SupergroupEventMessage<SupergroupEvent>

requireUnconnectedFromChannelGroupContentMessage

inline fun Message.requireUnconnectedFromChannelGroupContentMessage(): UnconnectedFromChannelGroupContentMessage<MessageContent>

requireUnknownMessageType

inline fun Message.requireUnknownMessageType(): UnknownMessageType

requireWithContent

inline fun <T : MessageContent> ChatContentMessage<*>.requireWithContent(): ChatContentMessage<T>

inline fun <T : MessageContent> ContentMessage<*>.requireWithContent(): ContentMessage<T>

inline fun <T : MessageContent> GroupContentMessage<*>.requireWithContent(): GroupContentMessage<T>

inline fun <T : MessageContent> PossiblySentViaBotCommonMessage<*>.requireWithContent(): PossiblySentViaBotCommonMessage<T>

inline fun <T : MessageContent> PublicContentMessage<*>.requireWithContent(): PublicContentMessage<T>

sameBusinessConnection

inline fun Message.sameBusinessConnection(other: WithBusinessConnectionId): Boolean

inline fun Message.sameBusinessConnection(id: BusinessConnectionId): Boolean

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

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

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

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

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

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

signedMessageOrNull

inline fun Message.signedMessageOrNull(): SignedMessage?

signedMessageOrThrow

inline fun Message.signedMessageOrThrow(): SignedMessage

specialMessageOrNull

inline fun Message.specialMessageOrNull(): SpecialMessage?

specialMessageOrThrow

inline fun Message.specialMessageOrThrow(): SpecialMessage

suggestedChannelDirectMessagesContentMessageOrNull

inline fun Message.suggestedChannelDirectMessagesContentMessageOrNull(): SuggestedChannelDirectMessagesContentMessage<MessageContent>?

suggestedChannelDirectMessagesContentMessageOrThrow

inline fun Message.suggestedChannelDirectMessagesContentMessageOrThrow(): SuggestedChannelDirectMessagesContentMessage<MessageContent>

supergroupEventMessageOrNull

inline fun Message.supergroupEventMessageOrNull(): SupergroupEventMessage<SupergroupEvent>?

supergroupEventMessageOrThrow

inline fun Message.supergroupEventMessageOrThrow(): SupergroupEventMessage<SupergroupEvent>

unconnectedFromChannelGroupContentMessageOrNull

inline fun Message.unconnectedFromChannelGroupContentMessageOrNull(): UnconnectedFromChannelGroupContentMessage<MessageContent>?

unconnectedFromChannelGroupContentMessageOrThrow

inline fun Message.unconnectedFromChannelGroupContentMessageOrThrow(): UnconnectedFromChannelGroupContentMessage<MessageContent>

unknownMessageTypeOrNull

inline fun Message.unknownMessageTypeOrNull(): UnknownMessageType?

unknownMessageTypeOrThrow

inline fun Message.unknownMessageTypeOrThrow(): UnknownMessageType

whenAnonymousGroupContentMessage

inline fun <T> Message.whenAnonymousGroupContentMessage(block: (AnonymousGroupContentMessage<MessageContent>) -> T): T?

whenAnonymousGroupContentMessageImpl

inline fun <T> Message.whenAnonymousGroupContentMessageImpl(block: (AnonymousGroupContentMessageImpl<MessageContent>) -> T): T?

whenChannelContentMessage

inline fun <T> Message.whenChannelContentMessage(block: (ChannelContentMessage<MessageContent>) -> T): T?

whenChannelContentMessageImpl

inline fun <T> Message.whenChannelContentMessageImpl(block: (UnconnectedFromChannelGroupContentMessageImpl<MessageContent>) -> T): T?

whenChannelEventMessage

inline fun <T> Message.whenChannelEventMessage(block: (ChannelEventMessage<ChannelEvent>) -> T): T?

whenChatEventMessage

inline fun <T> Message.whenChatEventMessage(block: (ChatEventMessage<ChatEvent>) -> T): T?

whenCommonGroupContentMessage

inline fun <T> Message.whenCommonGroupContentMessage(block: (CommonGroupContentMessage<MessageContent>) -> T): T?

whenCommonGroupEventMessage

inline fun <T> Message.whenCommonGroupEventMessage(block: (CommonGroupEventMessage<GroupEvent>) -> T): T?

whenCommonMessage

inline fun <T> Message.whenCommonMessage(block: (ChatContentMessage<MessageContent>) -> T): T?

whenCommonSupergroupEventMessage

inline fun <T> Message.whenCommonSupergroupEventMessage(block: (CommonSupergroupEventMessage<SupergroupEvent>) -> T): T?

whenConnectedFromChannelGroupContentMessage

inline fun <T> Message.whenConnectedFromChannelGroupContentMessage(block: (ConnectedFromChannelGroupContentMessage<MessageContent>) -> T): T?

whenContentMessage

inline fun <T> Message.whenContentMessage(block: (ContentMessage<MessageContent>) -> T): T?

whenFromChannelGroupContentMessage

inline fun <T> Message.whenFromChannelGroupContentMessage(block: (FromChannelGroupContentMessage<MessageContent>) -> T): T?

whenFromUserMessage

inline fun <T> Message.whenFromUserMessage(block: (FromUserMessage) -> T): T?

whenGroupContentMessage

inline fun <T> Message.whenGroupContentMessage(block: (GroupContentMessage<MessageContent>) -> T): T?

whenGroupEventMessage

inline fun <T> Message.whenGroupEventMessage(block: (GroupEventMessage<GroupEvent>) -> T): T?

whenMediaGroupMessage

inline fun <T> Message.whenMediaGroupMessage(block: (MediaGroupMessage<MediaGroupPartContent>) -> T): T?

whenPassportMessage

inline fun <T> Message.whenPassportMessage(block: (PassportMessage) -> T): T?

whenPossiblyEditedMessage

inline fun <T> Message.whenPossiblyEditedMessage(block: (PossiblyEditedMessage) -> T): T?

whenPossiblyForwardedMessage

inline fun <T> Message.whenPossiblyForwardedMessage(block: (PossiblyForwardedMessage) -> T): T?

whenPossiblyPaymentMessage

inline fun <T> Message.whenPossiblyPaymentMessage(block: (PossiblyPaymentMessage) -> T): T?

whenPossiblyReplyMessage

inline fun <T> Message.whenPossiblyReplyMessage(block: (PossiblyReplyMessage) -> T): T?

whenPossiblySentViaBotCommonMessage

inline fun <T> Message.whenPossiblySentViaBotCommonMessage(block: (PossiblySentViaBotCommonMessage<MessageContent>) -> T): T?

whenPrivateContentMessage

inline fun <T> Message.whenPrivateContentMessage(block: (PrivateContentMessage<MessageContent>) -> T): T?

whenPrivateContentMessageImpl

inline fun <T> Message.whenPrivateContentMessageImpl(block: (PrivateContentMessageImpl<MessageContent>) -> T): T?

whenPrivateEventMessage

inline fun <T> Message.whenPrivateEventMessage(block: (PrivateEventMessage<PrivateEvent>) -> T): T?

whenPublicContentMessage

inline fun <T> Message.whenPublicContentMessage(block: (PublicContentMessage<MessageContent>) -> T): T?

whenSignedMessage

inline fun <T> Message.whenSignedMessage(block: (SignedMessage) -> T): T?

whenSupergroupEventMessage

inline fun <T> Message.whenSupergroupEventMessage(block: (SupergroupEventMessage<SupergroupEvent>) -> T): T?

whenUnconnectedFromChannelGroupContentMessage

inline fun <T> Message.whenUnconnectedFromChannelGroupContentMessage(block: (UnconnectedFromChannelGroupContentMessage<MessageContent>) -> T): T?

whenUnknownMessageType

inline fun <T> Message.whenUnknownMessageType(block: (UnknownMessageType) -> T): T?

inline fun <T : MessageContent> ChatContentMessage<*>.withContent(): ChatContentMessage<T>?

inline fun <T : MessageContent> ContentMessage<*>.withContent(): ContentMessage<T>?

inline fun <T : MessageContent> GroupContentMessage<*>.withContent(): GroupContentMessage<T>?

inline fun <T : MessageContent> PossiblySentViaBotCommonMessage<*>.withContent(): PossiblySentViaBotCommonMessage<T>?

inline fun <T : MessageContent> PublicContentMessage<*>.withContent(): PublicContentMessage<T>?

withContentOrNull

inline fun <T : MessageContent> ChatContentMessage<*>.withContentOrNull(): ChatContentMessage<T>?

inline fun <T : MessageContent> ContentMessage<*>.withContentOrNull(): ContentMessage<T>?

inline fun <T : MessageContent> GroupContentMessage<*>.withContentOrNull(): GroupContentMessage<T>?

inline fun <T : MessageContent> PossiblySentViaBotCommonMessage<*>.withContentOrNull(): PossiblySentViaBotCommonMessage<T>?

inline fun <T : MessageContent> PublicContentMessage<*>.withContentOrNull(): PublicContentMessage<T>?

withContentOrThrow

inline fun <T : MessageContent> ChatContentMessage<*>.withContentOrThrow(): ChatContentMessage<T>

inline fun <T : MessageContent> ContentMessage<*>.withContentOrThrow(): ContentMessage<T>

inline fun <T : MessageContent> GroupContentMessage<*>.withContentOrThrow(): GroupContentMessage<T>

inline fun <T : MessageContent> PossiblySentViaBotCommonMessage<*>.withContentOrThrow(): PossiblySentViaBotCommonMessage<T>

inline fun <T : MessageContent> PublicContentMessage<*>.withContentOrThrow(): PublicContentMessage<T>