docs/dev.inmo.tgbotapi.extensions.utils.shortcuts

Package dev.inmo.tgbotapi.extensions.utils.shortcuts

Functions

animationMessages

fun Flow<BaseSentMessageUpdate>.animationMessages(): Flow<ContentMessage<AnimationContent>>

fun FlowsUpdatesFilter.animationMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<AnimationContent>>

fun Flow<BaseSentMessageUpdate>.audioMessages(): Flow<ContentMessage<AudioContent>>

fun FlowsUpdatesFilter.audioMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<AudioContent>>

audioMessagesWithMediaGroups

fun FlowsUpdatesFilter.audioMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<AudioContent>>

channelCreatedEvents

inline fun FlowsUpdatesFilter.channelCreatedEvents(): Flow<ChannelEventMessage<ChannelChatCreated>>

inline fun Flow<ChatEventMessage<*>>.channelCreatedEvents(): Flow<ChannelEventMessage<ChannelChatCreated>>

inline fun FlowsUpdatesFilter.channelEvents(): Flow<ChannelEventMessage<*>>

inline fun Flow<ChatEventMessage<*>>.channelEvents(): Flow<ChannelEventMessage<ChannelEvent>>

fun closePollAfter(seconds: Seconds): ApproximateScheduledCloseInfo

fun closePollAfter(seconds: LongSeconds): ApproximateScheduledCloseInfo

closePollExactAfter

fun closePollExactAfter(seconds: Seconds): ExactScheduledCloseInfo

fun closePollExactAfter(seconds: LongSeconds): ExactScheduledCloseInfo

closePollExactAt

fun closePollExactAt(dateTime: DateTime): ExactScheduledCloseInfo

contactMessages

fun Flow<BaseSentMessageUpdate>.contactMessages(): Flow<ContentMessage<ContactContent>>

fun FlowsUpdatesFilter.contactMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<ContactContent>>

fun SentMediaGroupUpdate.createResend(disableNotification: Boolean = false, protectContent: Boolean = false, replyTo: MessageIdentifier? = null): Request<List<MediaGroupMessage<MediaGroupContent>>>

fun List<CommonMessage<MediaGroupContent>>.createResend(chatId: ChatId, disableNotification: Boolean = false, protectContent: Boolean = false, replyTo: MessageIdentifier? = null): Request<List<MediaGroupMessage<MediaGroupContent>>>

fun List<CommonMessage<MediaGroupContent>>.createResend(chat: Chat, disableNotification: Boolean = false, protectContent: Boolean = false, replyTo: MessageIdentifier? = null): Request<List<MediaGroupMessage<MediaGroupContent>>>

deletedChannelPhotoEvents

inline fun FlowsUpdatesFilter.deletedChannelPhotoEvents(): Flow<ChannelEventMessage<DeleteChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.deletedChannelPhotoEvents(): Flow<ChannelEventMessage<DeleteChatPhoto>>

deletedGroupPhotoEvents

inline fun FlowsUpdatesFilter.deletedGroupPhotoEvents(): Flow<GroupEventMessage<DeleteChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.deletedGroupPhotoEvents(): Flow<GroupEventMessage<DeleteChatPhoto>>

deletedSupergroupPhotoEvents

inline fun FlowsUpdatesFilter.deletedSupergroupPhotoEvents(): Flow<SupergroupEventMessage<DeleteChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.deletedSupergroupPhotoEvents(): Flow<SupergroupEventMessage<DeleteChatPhoto>>

fun Flow<BaseSentMessageUpdate>.diceMessages(): Flow<ContentMessage<DiceContent>>

fun FlowsUpdatesFilter.diceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<DiceContent>>

documentMessages

fun Flow<BaseSentMessageUpdate>.documentMessages(): Flow<ContentMessage<DocumentContent>>

fun FlowsUpdatesFilter.documentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<DocumentContent>>

documentMessagesWithMediaGroups

fun FlowsUpdatesFilter.documentMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<DocumentContent>>

inline fun FlowsUpdatesFilter.events(): Flow<ChatEventMessage<*>>

suspend fun <T : Any> RequestsExecutor.executeAsync(request: Request<T>): Deferred<T>

fun <T : Any> RequestsExecutor.executeAsync(request: Request<T>, scope: CoroutineScope): Deferred<T>

suspend fun <T : Any> RequestsExecutor.executeUnsafe(request: Request<T>, retries: Int = 0, retriesDelay: Long = 1000, onAllFailed: suspend (exceptions: Array<Throwable>) -> Unit? = null): T?

filterByChatEvent

inline fun <T : ChatEvent, O : ChatEventMessage<T>> Flow<ChatEventMessage<*>>.filterByChatEvent(): Flow<O>

filterChannelEvents

inline fun <T : ChannelEvent> FlowsUpdatesFilter.filterChannelEvents(): Flow<ChannelEventMessage<T>>

inline fun <T : ChannelEvent> Flow<ChatEventMessage<*>>.filterChannelEvents(): Flow<ChannelEventMessage<T>>

filterCommandsInsideTextMessages

fun <T : ContentMessage<TextContent>> Flow<T>.filterCommandsInsideTextMessages(commandRegex: Regex): Flow<T>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex

filterCommandsWithArgs

fun <T : ContentMessage<TextContent>> Flow<T>.filterCommandsWithArgs(commandRegex: Regex): Flow<Pair<T, List<TextSource>>>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains first TextSource as BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex and for other TextSource objects used next rules: all incoming text sources will be passed as is, RegularTextSource will be split by " " for several RegularTextSource which will contains not empty args without spaces.

filterContentMessages

inline fun <T : MessageContent> Flow<BaseSentMessageUpdate>.filterContentMessages(): Flow<ContentMessage<T>>

inline fun <T : MessageContent> FlowsUpdatesFilter.filterContentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<T>>

filterExactCommands

fun <T : ContentMessage<TextContent>> Flow<T>.filterExactCommands(commandRegex: Regex): Flow<T>

Convert incoming dev.inmo.tgbotapi.types.message.abstracts.ContentMessage.content of messages with fullEntitiesList and check that incoming message contains ONLY ONE TextSource and that is BotCommandTextSource. Besides, it is checking that BotCommandTextSource.command with incoming commandRegex

filterForContentMessage

inline fun <T : MessageContent> filterForContentMessage(): suspend (ContentMessage<*>) -> ContentMessage<T>?

filterGroupEvents

inline fun <T : GroupEvent> FlowsUpdatesFilter.filterGroupEvents(): Flow<GroupEventMessage<T>>

inline fun <T : GroupEvent> Flow<ChatEventMessage<*>>.filterGroupEvents(): Flow<GroupEventMessage<T>>

filterMediaGroupMessages

inline fun <T : MediaGroupContent> Flow<SentMediaGroupUpdate>.filterMediaGroupMessages(): Flow<List<CommonMessage<T>>>

inline fun <T : MediaGroupContent> FlowsUpdatesFilter.filterMediaGroupMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<T>>>

filterPrivateEvents

inline fun <T : PrivateEvent> FlowsUpdatesFilter.filterPrivateEvents(): Flow<PrivateEventMessage<T>>

inline fun <T : PrivateEvent> Flow<ChatEventMessage<*>>.filterPrivateEvents(): Flow<PrivateEventMessage<T>>

filterSupergroupEvents

inline fun <T : SupergroupEvent> FlowsUpdatesFilter.filterSupergroupEvents(): Flow<SupergroupEventMessage<T>>

inline fun <T : SupergroupEvent> Flow<ChatEventMessage<*>>.filterSupergroupEvents(): Flow<SupergroupEventMessage<T>>

fun Flow<BaseSentMessageUpdate>.gameMessages(): Flow<ContentMessage<GameContent>>

fun FlowsUpdatesFilter.gameMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<GameContent>>

groupCreatedEvents

inline fun FlowsUpdatesFilter.groupCreatedEvents(): Flow<GroupEventMessage<GroupChatCreated>>

inline fun Flow<ChatEventMessage<*>>.groupCreatedEvents(): Flow<GroupEventMessage<GroupChatCreated>>

inline fun FlowsUpdatesFilter.groupEvents(): Flow<GroupEventMessage<*>>

inline fun Flow<ChatEventMessage<*>>.groupEvents(): Flow<GroupEventMessage<GroupEvent>>

fun Flow<BaseSentMessageUpdate>.imageMessages(): Flow<ContentMessage<PhotoContent>>

inline fun FlowsUpdatesFilter.imageMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

Shortcut for photoMessages

imageMessagesWithMediaGroups

fun FlowsUpdatesFilter.imageMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

invoiceMessages

fun Flow<BaseSentMessageUpdate>.invoiceMessages(): Flow<ContentMessage<InvoiceContent>>

fun FlowsUpdatesFilter.invoiceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<InvoiceContent>>

leftGroupMemberEvents

inline fun FlowsUpdatesFilter.leftGroupMemberEvents(): Flow<GroupEventMessage<LeftChatMember>>

inline fun Flow<ChatEventMessage<*>>.leftGroupMemberEvents(): Flow<GroupEventMessage<LeftChatMember>>

leftSupergroupMemberEvents

inline fun FlowsUpdatesFilter.leftSupergroupMemberEvents(): Flow<SupergroupEventMessage<LeftChatMember>>

inline fun Flow<ChatEventMessage<*>>.leftSupergroupMemberEvents(): Flow<SupergroupEventMessage<LeftChatMember>>

locationMessages

fun Flow<BaseSentMessageUpdate>.locationMessages(): Flow<ContentMessage<LocationContent>>

fun FlowsUpdatesFilter.locationMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<LocationContent>>

mediaGroupAudioMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupAudioMessages(): Flow<List<CommonMessage<AudioContent>>>

fun FlowsUpdatesFilter.mediaGroupAudioMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<AudioContent>>>

mediaGroupDocumentMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupDocumentMessages(): Flow<List<CommonMessage<DocumentContent>>>

fun FlowsUpdatesFilter.mediaGroupDocumentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<DocumentContent>>>

mediaGroupMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupMessages(): Flow<List<CommonMessage<MediaGroupContent>>>

fun FlowsUpdatesFilter.mediaGroupMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<MediaGroupContent>>>

mediaGroupPhotosMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupPhotosMessages(): Flow<List<CommonMessage<PhotoContent>>>

fun FlowsUpdatesFilter.mediaGroupPhotosMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<PhotoContent>>>

mediaGroupVideosMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupVideosMessages(): Flow<List<CommonMessage<VideoContent>>>

fun FlowsUpdatesFilter.mediaGroupVideosMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<VideoContent>>>

mediaGroupVisualMessages

fun Flow<SentMediaGroupUpdate>.mediaGroupVisualMessages(): Flow<List<CommonMessage<VisualMediaGroupContent>>>

fun FlowsUpdatesFilter.mediaGroupVisualMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<List<CommonMessage<VisualMediaGroupContent>>>

newChannelPhotoEvents

inline fun FlowsUpdatesFilter.newChannelPhotoEvents(): Flow<ChannelEventMessage<NewChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.newChannelPhotoEvents(): Flow<ChannelEventMessage<NewChatPhoto>>

newChannelPinnedMessageEvents

inline fun FlowsUpdatesFilter.newChannelPinnedMessageEvents(): Flow<ChannelEventMessage<PinnedMessage>>

inline fun Flow<ChatEventMessage<*>>.newChannelPinnedMessageEvents(): Flow<ChannelEventMessage<PinnedMessage>>

newChannelTitleEvents

inline fun FlowsUpdatesFilter.newChannelTitleEvents(): Flow<ChannelEventMessage<NewChatTitle>>

inline fun Flow<ChatEventMessage<*>>.newChannelTitleEvents(): Flow<ChannelEventMessage<NewChatTitle>>

newGroupMembersEvents

inline fun FlowsUpdatesFilter.newGroupMembersEvents(): Flow<GroupEventMessage<NewChatMembers>>

inline fun Flow<ChatEventMessage<*>>.newGroupMembersEvents(): Flow<GroupEventMessage<NewChatMembers>>

newGroupPhotoEvents

inline fun FlowsUpdatesFilter.newGroupPhotoEvents(): Flow<GroupEventMessage<NewChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.newGroupPhotoEvents(): Flow<GroupEventMessage<NewChatPhoto>>

newGroupPinnedMessageEvents

inline fun FlowsUpdatesFilter.newGroupPinnedMessageEvents(): Flow<GroupEventMessage<PinnedMessage>>

inline fun Flow<ChatEventMessage<*>>.newGroupPinnedMessageEvents(): Flow<GroupEventMessage<PinnedMessage>>

newGroupTitleEvents

inline fun FlowsUpdatesFilter.newGroupTitleEvents(): Flow<GroupEventMessage<NewChatTitle>>

inline fun Flow<ChatEventMessage<*>>.newGroupTitleEvents(): Flow<GroupEventMessage<NewChatTitle>>

newPrivatePinnedMessageEvents

inline fun FlowsUpdatesFilter.newPrivatePinnedMessageEvents(): Flow<PrivateEventMessage<PinnedMessage>>

inline fun Flow<ChatEventMessage<*>>.newPrivatePinnedMessageEvents(): Flow<PrivateEventMessage<PinnedMessage>>

newSupergroupMembersEvents

inline fun FlowsUpdatesFilter.newSupergroupMembersEvents(): Flow<SupergroupEventMessage<NewChatMembers>>

inline fun Flow<ChatEventMessage<*>>.newSupergroupMembersEvents(): Flow<SupergroupEventMessage<NewChatMembers>>

newSupergroupPhotoEvents

inline fun FlowsUpdatesFilter.newSupergroupPhotoEvents(): Flow<SupergroupEventMessage<NewChatPhoto>>

inline fun Flow<ChatEventMessage<*>>.newSupergroupPhotoEvents(): Flow<SupergroupEventMessage<NewChatPhoto>>

newSupergroupPinnedMessageEvents

inline fun FlowsUpdatesFilter.newSupergroupPinnedMessageEvents(): Flow<SupergroupEventMessage<PinnedMessage>>

inline fun Flow<ChatEventMessage<*>>.newSupergroupPinnedMessageEvents(): Flow<SupergroupEventMessage<PinnedMessage>>

newSupergroupTitleEvents

inline fun FlowsUpdatesFilter.newSupergroupTitleEvents(): Flow<SupergroupEventMessage<NewChatTitle>>

inline fun Flow<ChatEventMessage<*>>.newSupergroupTitleEvents(): Flow<SupergroupEventMessage<NewChatTitle>>

fun Flow<BaseSentMessageUpdate>.photoMessages(): Flow<ContentMessage<PhotoContent>>

fun FlowsUpdatesFilter.photoMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

photoMessagesWithMediaGroups

fun FlowsUpdatesFilter.photoMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PhotoContent>>

fun Flow<BaseSentMessageUpdate>.pollMessages(): Flow<ContentMessage<PollContent>>

fun FlowsUpdatesFilter.pollMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<PollContent>>

inline fun FlowsUpdatesFilter.privateEvents(): Flow<PrivateEventMessage<*>>

inline fun Flow<ChatEventMessage<*>>.privateEvents(): Flow<PrivateEventMessage<PrivateEvent>>

proximityAlertTriggeredInGroupEvents

inline fun FlowsUpdatesFilter.proximityAlertTriggeredInGroupEvents(): Flow<GroupEventMessage<ProximityAlertTriggered>>

inline fun Flow<ChatEventMessage<*>>.proximityAlertTriggeredInGroupEvents(): Flow<GroupEventMessage<ProximityAlertTriggered>>

proximityAlertTriggeredInSupergroupEvents

inline fun FlowsUpdatesFilter.proximityAlertTriggeredInSupergroupEvents(): Flow<SupergroupEventMessage<ProximityAlertTriggered>>

inline fun Flow<ChatEventMessage<*>>.proximityAlertTriggeredInSupergroupEvents(): Flow<SupergroupEventMessage<ProximityAlertTriggered>>

fun FlowsUpdatesFilter.sentMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<MessageContent>>

sentMessagesWithMediaGroups

fun FlowsUpdatesFilter.sentMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<MessageContent>>

stickerMessages

fun Flow<BaseSentMessageUpdate>.stickerMessages(): Flow<ContentMessage<StickerContent>>

fun FlowsUpdatesFilter.stickerMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<StickerContent>>

successfulPaymentInChannelEvents

inline fun FlowsUpdatesFilter.successfulPaymentInChannelEvents(): Flow<ChannelEventMessage<SuccessfulPaymentEvent>>

inline fun Flow<ChatEventMessage<*>>.successfulPaymentInChannelEvents(): Flow<ChannelEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInGroupEvents

inline fun FlowsUpdatesFilter.successfulPaymentInGroupEvents(): Flow<GroupEventMessage<SuccessfulPaymentEvent>>

inline fun Flow<ChatEventMessage<*>>.successfulPaymentInGroupEvents(): Flow<GroupEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInPrivateEvents

inline fun FlowsUpdatesFilter.successfulPaymentInPrivateEvents(): Flow<PrivateEventMessage<SuccessfulPaymentEvent>>

inline fun Flow<ChatEventMessage<*>>.successfulPaymentInPrivateEvents(): Flow<PrivateEventMessage<SuccessfulPaymentEvent>>

successfulPaymentInSupergroupEvents

inline fun FlowsUpdatesFilter.successfulPaymentInSupergroupEvents(): Flow<SupergroupEventMessage<SuccessfulPaymentEvent>>

inline fun Flow<ChatEventMessage<*>>.successfulPaymentInSupergroupEvents(): Flow<SupergroupEventMessage<SuccessfulPaymentEvent>>

supergroupCreatedEvents

inline fun FlowsUpdatesFilter.supergroupCreatedEvents(): Flow<SupergroupEventMessage<SupergroupChatCreated>>

inline fun Flow<ChatEventMessage<*>>.supergroupCreatedEvents(): Flow<SupergroupEventMessage<SupergroupChatCreated>>

supergroupEvents

inline fun FlowsUpdatesFilter.supergroupEvents(): Flow<SupergroupEventMessage<*>>

inline fun Flow<ChatEventMessage<*>>.supergroupEvents(): Flow<SupergroupEventMessage<SupergroupEvent>>

fun Flow<BaseSentMessageUpdate>.textMessages(): Flow<ContentMessage<TextContent>>

fun FlowsUpdatesFilter.textMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<TextContent>>

fun Flow<BaseSentMessageUpdate>.venueMessages(): Flow<ContentMessage<VenueContent>>

fun FlowsUpdatesFilter.venueMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VenueContent>>

fun Flow<BaseSentMessageUpdate>.videoMessages(): Flow<ContentMessage<VideoContent>>

fun FlowsUpdatesFilter.videoMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VideoContent>>

videoMessagesWithMediaGroups

fun FlowsUpdatesFilter.videoMessagesWithMediaGroups(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VideoContent>>

videoNoteMessages

fun Flow<BaseSentMessageUpdate>.videoNoteMessages(): Flow<ContentMessage<VideoNoteContent>>

fun FlowsUpdatesFilter.videoNoteMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VideoNoteContent>>

fun Flow<BaseSentMessageUpdate>.voiceMessages(): Flow<ContentMessage<VoiceContent>>

fun FlowsUpdatesFilter.voiceMessages(scopeToIncludeChannels: CoroutineScope? = null): Flow<ContentMessage<VoiceContent>>

Properties

val List<CommonMessage<out MediaGroupContent>>.chat: Chat?

val SentMediaGroupUpdate.chat: Chat

val List<CommonMessage<out MediaGroupContent>>.forwardInfo: ForwardInfo?

val SentMediaGroupUpdate.forwardInfo: ForwardInfo?

val List<MediaGroupMessage<*>>.mediaGroupId: MediaGroupIdentifier?

val SentMediaGroupUpdate.mediaGroupId: MediaGroupIdentifier

val List<CommonMessage<out MediaGroupContent>>.replyTo: Message?

val SentMediaGroupUpdate.replyTo: Message?