docs/dev.inmo.tgbotapi.types.gifts/GiftSentOrReceivedEvent/RegularGift

RegularGift

@Serializable(with = GiftSentOrReceivedEvent.RegularGift.Companion::class)

sealed interface RegularGift : GiftSentOrReceivedEvent, TextedInput(source)

Represent the hierarchy of GiftInfo.

For GiftInfo with owned_gift_id see RegularGift.ReceivedInBusinessAccount
For all other kinds see RegularGift.Common

Inheritors

Common

ReceivedInBusinessAccount

Types

Common

@Serializable

data class Common(val gift: Gift.Regular, val convertStarCount: Int? = null, val prepaidUpgradeStarCount: Int? = null, val canBeUpgraded: Boolean = false, val text: String? = null, entities: RawMessageEntities? = null, val isPrivate: Boolean = false, val isUpgradeSeparate: Boolean = false, val uniqueGiftNumber: Int? = null, val nextTransferDate: TelegramDate? = null) : GiftSentOrReceivedEvent.RegularGift

Companion

object Companion : KSerializer<GiftSentOrReceivedEvent.RegularGift>

ReceivedInBusinessAccount

@Serializable

data class ReceivedInBusinessAccount(val gift: Gift.Regular, val ownedGiftId: GiftId, val convertStarCount: Int? = null, val prepaidUpgradeStarCount: Int? = null, val canBeUpgraded: Boolean = false, val text: String? = null, entities: RawMessageEntities? = null, val isPrivate: Boolean = false, val isUpgradeSeparate: Boolean = false, val uniqueGiftNumber: Int? = null, val nextTransferDate: TelegramDate? = null) : GiftSentOrReceivedEvent.RegularGift, GiftSentOrReceivedEvent.ReceivedInBusinessAccount

Properties

canBeUpgraded

abstract val canBeUpgraded: Boolean

convertStarCount

abstract val convertStarCount: Int?

gift

abstract override val gift: Gift.Regular

isPrivate

abstract val isPrivate: Boolean

isUpgradeSeparate

abstract val isUpgradeSeparate: Boolean

nextTransferDate

abstract val nextTransferDate: TelegramDate?

ownedGiftId

abstract val ownedGiftId: GiftId?

prepaidUpgradeStarCount

abstract val prepaidUpgradeStarCount: Int?

text

abstract val text: String?

textSources

abstract override val textSources: List<TextSource>

Full list of TextSources

uniqueGiftNumber

abstract val uniqueGiftNumber: Int?

Functions

asChannelChatCreated

inline fun ChatEvent.asChannelChatCreated(): ChannelChatCreated?

asChannelEvent

inline fun ChatEvent.asChannelEvent(): ChannelEvent?

asChatOwnerChanged

inline fun ChatEvent.asChatOwnerChanged(): ChatOwnerChanged?

asChatOwnerLeft

inline fun ChatEvent.asChatOwnerLeft(): ChatOwnerLeft?

asCommonEvent

inline fun ChatEvent.asCommonEvent(): CommonEvent?

asDeleteChatPhoto

inline fun ChatEvent.asDeleteChatPhoto(): DeleteChatPhoto?

asGroupChatCreated

inline fun ChatEvent.asGroupChatCreated(): GroupChatCreated?

asGroupEvent

inline fun ChatEvent.asGroupEvent(): GroupEvent?

asLeftChatMember

inline fun ChatEvent.asLeftChatMember(): LeftChatMemberEvent?

asMessageAutoDeleteTimerChanged

inline fun ChatEvent.asMessageAutoDeleteTimerChanged(): MessageAutoDeleteTimerChanged?

asMigratedToSupergroup

inline fun ChatEvent.asMigratedToSupergroup(): MigratedToSupergroup?

asNewChatMembers

inline fun ChatEvent.asNewChatMembers(): NewChatMembers?

asNewChatPhoto

inline fun ChatEvent.asNewChatPhoto(): NewChatPhoto?

asNewChatTitle

inline fun ChatEvent.asNewChatTitle(): NewChatTitle?

asPinnedMessage

inline fun ChatEvent.asPinnedMessage(): PinnedMessage?

asProximityAlertTriggered

inline fun ChatEvent.asProximityAlertTriggered(): ProximityAlertTriggered?

asPublicChatEvent

inline fun ChatEvent.asPublicChatEvent(): PublicChatEvent?

asRefundedPaymentEvent

inline fun ChatEvent.asRefundedPaymentEvent(): RefundedPaymentEvent?

asSuccessfulPaymentEvent

inline fun ChatEvent.asSuccessfulPaymentEvent(): SuccessfulPaymentEvent?

asSupergroupChatCreated

inline fun ChatEvent.asSupergroupChatCreated(): SupergroupChatCreated?

asSupergroupEvent

inline fun ChatEvent.asSupergroupEvent(): SupergroupEvent?

asUserLoggedIn

inline fun ChatEvent.asUserLoggedIn(): UserLoggedIn?

asVideoChatEnded

inline fun ChatEvent.asVideoChatEnded(): VideoChatEnded?

asVideoChatEvent

inline fun ChatEvent.asVideoChatEvent(): VideoChatEvent?

asVideoChatParticipantsInvited

inline fun ChatEvent.asVideoChatParticipantsInvited(): VideoChatParticipantsInvited?

asVideoChatScheduled

inline fun ChatEvent.asVideoChatScheduled(): VideoChatScheduled?

asVideoChatStarted

inline fun ChatEvent.asVideoChatStarted(): VideoChatStarted?

channelChatCreatedOrNull

inline fun ChatEvent.channelChatCreatedOrNull(): ChannelChatCreated?

channelChatCreatedOrThrow

inline fun ChatEvent.channelChatCreatedOrThrow(): ChannelChatCreated

channelDirectMessagesEventOrNull

inline fun ChatEvent.channelDirectMessagesEventOrNull(): ChannelDirectMessagesEvent?

channelDirectMessagesEventOrThrow

inline fun ChatEvent.channelDirectMessagesEventOrThrow(): ChannelDirectMessagesEvent

channelEventOrNull

inline fun ChatEvent.channelEventOrNull(): ChannelEvent?

channelEventOrThrow

inline fun ChatEvent.channelEventOrThrow(): ChannelEvent

chatBackgroundOrNull

inline fun ChatEvent.chatBackgroundOrNull(): ChatBackground?

chatBackgroundOrThrow

inline fun ChatEvent.chatBackgroundOrThrow(): ChatBackground

chatBoostAddedOrNull

inline fun ChatEvent.chatBoostAddedOrNull(): ChatBoostAdded?

chatBoostAddedOrThrow

inline fun ChatEvent.chatBoostAddedOrThrow(): ChatBoostAdded

chatOwnerChangedOrNull

inline fun ChatEvent.chatOwnerChangedOrNull(): ChatOwnerChanged?

chatOwnerChangedOrThrow

inline fun ChatEvent.chatOwnerChangedOrThrow(): ChatOwnerChanged

chatOwnerLeftOrNull

inline fun ChatEvent.chatOwnerLeftOrNull(): ChatOwnerLeft?

chatOwnerLeftOrThrow

inline fun ChatEvent.chatOwnerLeftOrThrow(): ChatOwnerLeft

chatSharedOrNull

inline fun ChatEvent.chatSharedOrNull(): ChatShared?

chatSharedOrThrow

inline fun ChatEvent.chatSharedOrThrow(): ChatShared

chatSharedRequestOrNull

inline fun ChatEvent.chatSharedRequestOrNull(): ChatSharedRequest?

chatSharedRequestOrThrow

inline fun ChatEvent.chatSharedRequestOrThrow(): ChatSharedRequest

checklistTasksAddedOrNull

inline fun ChatEvent.checklistTasksAddedOrNull(): ChecklistTasksAdded?

checklistTasksAddedOrThrow

inline fun ChatEvent.checklistTasksAddedOrThrow(): ChecklistTasksAdded

checklistTasksDoneOrNull

inline fun ChatEvent.checklistTasksDoneOrNull(): ChecklistTasksDone?

checklistTasksDoneOrThrow

inline fun ChatEvent.checklistTasksDoneOrThrow(): ChecklistTasksDone

commonEventOrNull

inline fun ChatEvent.commonEventOrNull(): CommonEvent?

commonEventOrThrow

inline fun ChatEvent.commonEventOrThrow(): CommonEvent

deleteChatPhotoOrNull

inline fun ChatEvent.deleteChatPhotoOrNull(): DeleteChatPhoto?

deleteChatPhotoOrThrow

inline fun ChatEvent.deleteChatPhotoOrThrow(): DeleteChatPhoto

directMessagesConfigurationChangedDisabledOrNull

inline fun ChatEvent.directMessagesConfigurationChangedDisabledOrNull(): DirectMessagesConfigurationChanged.Disabled?

directMessagesConfigurationChangedDisabledOrThrow

inline fun ChatEvent.directMessagesConfigurationChangedDisabledOrThrow(): DirectMessagesConfigurationChanged.Disabled

directMessagesConfigurationChangedFreeOrNull

inline fun ChatEvent.directMessagesConfigurationChangedFreeOrNull(): DirectMessagesConfigurationChanged.Free?

directMessagesConfigurationChangedFreeOrThrow

inline fun ChatEvent.directMessagesConfigurationChangedFreeOrThrow(): DirectMessagesConfigurationChanged.Free

directMessagesConfigurationChangedOrNull

inline fun ChatEvent.directMessagesConfigurationChangedOrNull(): DirectMessagesConfigurationChanged?

directMessagesConfigurationChangedOrThrow

inline fun ChatEvent.directMessagesConfigurationChangedOrThrow(): DirectMessagesConfigurationChanged

directMessagesConfigurationChangedPaidOrNull

inline fun ChatEvent.directMessagesConfigurationChangedPaidOrNull(): DirectMessagesConfigurationChanged.Paid?

directMessagesConfigurationChangedPaidOrThrow

inline fun ChatEvent.directMessagesConfigurationChangedPaidOrThrow(): DirectMessagesConfigurationChanged.Paid

forumEventOrNull

inline fun ChatEvent.forumEventOrNull(): ForumEvent?

forumEventOrThrow

inline fun ChatEvent.forumEventOrThrow(): ForumEvent

forumTopicClosedOrNull

inline fun ChatEvent.forumTopicClosedOrNull(): ForumTopicClosed?

forumTopicClosedOrThrow

inline fun ChatEvent.forumTopicClosedOrThrow(): ForumTopicClosed

forumTopicCreatedOrNull

inline fun ChatEvent.forumTopicCreatedOrNull(): ForumTopicCreated?

forumTopicCreatedOrThrow

inline fun ChatEvent.forumTopicCreatedOrThrow(): ForumTopicCreated

forumTopicEditedOrNull

inline fun ChatEvent.forumTopicEditedOrNull(): ForumTopicEdited?

forumTopicEditedOrThrow

inline fun ChatEvent.forumTopicEditedOrThrow(): ForumTopicEdited

forumTopicReopenedOrNull

inline fun ChatEvent.forumTopicReopenedOrNull(): ForumTopicReopened?

forumTopicReopenedOrThrow

inline fun ChatEvent.forumTopicReopenedOrThrow(): ForumTopicReopened

generalForumTopicHiddenOrNull

inline fun ChatEvent.generalForumTopicHiddenOrNull(): GeneralForumTopicHidden?

generalForumTopicHiddenOrThrow

inline fun ChatEvent.generalForumTopicHiddenOrThrow(): GeneralForumTopicHidden

generalForumTopicUnhiddenOrNull

inline fun ChatEvent.generalForumTopicUnhiddenOrNull(): GeneralForumTopicUnhidden?

generalForumTopicUnhiddenOrThrow

inline fun ChatEvent.generalForumTopicUnhiddenOrThrow(): GeneralForumTopicUnhidden

giftSentOrReceivedEventOrNull

inline fun ChatEvent.giftSentOrReceivedEventOrNull(): GiftSentOrReceivedEvent?

giftSentOrReceivedEventOrThrow

inline fun ChatEvent.giftSentOrReceivedEventOrThrow(): GiftSentOrReceivedEvent

giftSentOrReceivedEventReceivedInBusinessAccountOrNull

inline fun ChatEvent.giftSentOrReceivedEventReceivedInBusinessAccountOrNull(): GiftSentOrReceivedEvent.ReceivedInBusinessAccount?

giftSentOrReceivedEventReceivedInBusinessAccountOrThrow

inline fun ChatEvent.giftSentOrReceivedEventReceivedInBusinessAccountOrThrow(): GiftSentOrReceivedEvent.ReceivedInBusinessAccount

giftSentOrReceivedEventRegularGiftCommonOrNull

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftCommonOrNull(): GiftSentOrReceivedEvent.RegularGift.Common?

giftSentOrReceivedEventRegularGiftCommonOrThrow

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftCommonOrThrow(): GiftSentOrReceivedEvent.RegularGift.Common

giftSentOrReceivedEventRegularGiftOrNull

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftOrNull(): GiftSentOrReceivedEvent.RegularGift?

giftSentOrReceivedEventRegularGiftOrThrow

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftOrThrow(): GiftSentOrReceivedEvent.RegularGift

giftSentOrReceivedEventRegularGiftReceivedInBusinessAccountOrNull

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftReceivedInBusinessAccountOrNull(): GiftSentOrReceivedEvent.RegularGift.ReceivedInBusinessAccount?

giftSentOrReceivedEventRegularGiftReceivedInBusinessAccountOrThrow

inline fun ChatEvent.giftSentOrReceivedEventRegularGiftReceivedInBusinessAccountOrThrow(): GiftSentOrReceivedEvent.RegularGift.ReceivedInBusinessAccount

giftSentOrReceivedEventUniqueGiftCommonOrNull

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftCommonOrNull(): GiftSentOrReceivedEvent.UniqueGift.Common?

giftSentOrReceivedEventUniqueGiftCommonOrThrow

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftCommonOrThrow(): GiftSentOrReceivedEvent.UniqueGift.Common

giftSentOrReceivedEventUniqueGiftOrNull

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftOrNull(): GiftSentOrReceivedEvent.UniqueGift?

giftSentOrReceivedEventUniqueGiftOrThrow

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftOrThrow(): GiftSentOrReceivedEvent.UniqueGift

giftSentOrReceivedEventUniqueGiftReceivedInBusinessAccountOrNull

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftReceivedInBusinessAccountOrNull(): GiftSentOrReceivedEvent.UniqueGift.ReceivedInBusinessAccount?

giftSentOrReceivedEventUniqueGiftReceivedInBusinessAccountOrThrow

inline fun ChatEvent.giftSentOrReceivedEventUniqueGiftReceivedInBusinessAccountOrThrow(): GiftSentOrReceivedEvent.UniqueGift.ReceivedInBusinessAccount

giveawayCreatedCompanionOrNull

inline fun ChatEvent.giveawayCreatedCompanionOrNull(): GiveawayCreated.Companion?

giveawayCreatedCompanionOrThrow

inline fun ChatEvent.giveawayCreatedCompanionOrThrow(): GiveawayCreated.Companion

giveawayCreatedOrNull

inline fun ChatEvent.giveawayCreatedOrNull(): GiveawayCreated?

giveawayCreatedOrThrow

inline fun ChatEvent.giveawayCreatedOrThrow(): GiveawayCreated

giveawayCreatedStarsOrNull

inline fun ChatEvent.giveawayCreatedStarsOrNull(): GiveawayCreated.Stars?

giveawayCreatedStarsOrThrow

inline fun ChatEvent.giveawayCreatedStarsOrThrow(): GiveawayCreated.Stars

giveawayPrivateResultsOrNull

inline fun ChatEvent.giveawayPrivateResultsOrNull(): GiveawayPrivateResults?

giveawayPrivateResultsOrThrow

inline fun ChatEvent.giveawayPrivateResultsOrThrow(): GiveawayPrivateResults

groupChatCreatedOrNull

inline fun ChatEvent.groupChatCreatedOrNull(): GroupChatCreated?

groupChatCreatedOrThrow

inline fun ChatEvent.groupChatCreatedOrThrow(): GroupChatCreated

groupEventOrNull

inline fun ChatEvent.groupEventOrNull(): GroupEvent?

groupEventOrThrow

inline fun ChatEvent.groupEventOrThrow(): GroupEvent

ifChannelChatCreated

inline fun <T> ChatEvent.ifChannelChatCreated(block: (ChannelChatCreated) -> T): T?

ifChannelDirectMessagesEvent

inline fun <T> ChatEvent.ifChannelDirectMessagesEvent(block: (ChannelDirectMessagesEvent) -> T): T?

ifChannelEvent

inline fun <T> ChatEvent.ifChannelEvent(block: (ChannelEvent) -> T): T?

ifChatBackground

inline fun <T> ChatEvent.ifChatBackground(block: (ChatBackground) -> T): T?

ifChatBoostAdded

inline fun <T> ChatEvent.ifChatBoostAdded(block: (ChatBoostAdded) -> T): T?

ifChatOwnerChanged

inline fun <T> ChatEvent.ifChatOwnerChanged(block: (ChatOwnerChanged) -> T): T?

ifChatOwnerLeft

inline fun <T> ChatEvent.ifChatOwnerLeft(block: (ChatOwnerLeft) -> T): T?

ifChatShared

inline fun <T> ChatEvent.ifChatShared(block: (ChatShared) -> T): T?

ifChatSharedRequest

inline fun <T> ChatEvent.ifChatSharedRequest(block: (ChatSharedRequest) -> T): T?

ifChecklistTasksAdded

inline fun <T> ChatEvent.ifChecklistTasksAdded(block: (ChecklistTasksAdded) -> T): T?

ifChecklistTasksDone

inline fun <T> ChatEvent.ifChecklistTasksDone(block: (ChecklistTasksDone) -> T): T?

ifCommonEvent

inline fun <T> ChatEvent.ifCommonEvent(block: (CommonEvent) -> T): T?

ifDeleteChatPhoto

inline fun <T> ChatEvent.ifDeleteChatPhoto(block: (DeleteChatPhoto) -> T): T?

ifDirectMessagesConfigurationChanged

inline fun <T> ChatEvent.ifDirectMessagesConfigurationChanged(block: (DirectMessagesConfigurationChanged) -> T): T?

ifDirectMessagesConfigurationChangedDisabled

inline fun <T> ChatEvent.ifDirectMessagesConfigurationChangedDisabled(block: (DirectMessagesConfigurationChanged.Disabled) -> T): T?

ifDirectMessagesConfigurationChangedFree

inline fun <T> ChatEvent.ifDirectMessagesConfigurationChangedFree(block: (DirectMessagesConfigurationChanged.Free) -> T): T?

ifDirectMessagesConfigurationChangedPaid

inline fun <T> ChatEvent.ifDirectMessagesConfigurationChangedPaid(block: (DirectMessagesConfigurationChanged.Paid) -> T): T?

ifForumEvent

inline fun <T> ChatEvent.ifForumEvent(block: (ForumEvent) -> T): T?

ifForumTopicClosed

inline fun <T> ChatEvent.ifForumTopicClosed(block: (ForumTopicClosed) -> T): T?

ifForumTopicCreated

inline fun <T> ChatEvent.ifForumTopicCreated(block: (ForumTopicCreated) -> T): T?

ifForumTopicEdited

inline fun <T> ChatEvent.ifForumTopicEdited(block: (ForumTopicEdited) -> T): T?

ifForumTopicReopened

inline fun <T> ChatEvent.ifForumTopicReopened(block: (ForumTopicReopened) -> T): T?

ifGeneralForumTopicHidden

inline fun <T> ChatEvent.ifGeneralForumTopicHidden(block: (GeneralForumTopicHidden) -> T): T?

ifGeneralForumTopicUnhidden

inline fun <T> ChatEvent.ifGeneralForumTopicUnhidden(block: (GeneralForumTopicUnhidden) -> T): T?

ifGiftSentOrReceivedEvent

inline fun <T> ChatEvent.ifGiftSentOrReceivedEvent(block: (GiftSentOrReceivedEvent) -> T): T?

ifGiftSentOrReceivedEventReceivedInBusinessAccount

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventReceivedInBusinessAccount(block: (GiftSentOrReceivedEvent.ReceivedInBusinessAccount) -> T): T?

ifGiftSentOrReceivedEventRegularGift

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventRegularGift(block: (GiftSentOrReceivedEvent.RegularGift) -> T): T?

ifGiftSentOrReceivedEventRegularGiftCommon

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventRegularGiftCommon(block: (GiftSentOrReceivedEvent.RegularGift.Common) -> T): T?

ifGiftSentOrReceivedEventRegularGiftReceivedInBusinessAccount

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventRegularGiftReceivedInBusinessAccount(block: (GiftSentOrReceivedEvent.RegularGift.ReceivedInBusinessAccount) -> T): T?

ifGiftSentOrReceivedEventUniqueGift

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventUniqueGift(block: (GiftSentOrReceivedEvent.UniqueGift) -> T): T?

ifGiftSentOrReceivedEventUniqueGiftCommon

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventUniqueGiftCommon(block: (GiftSentOrReceivedEvent.UniqueGift.Common) -> T): T?

ifGiftSentOrReceivedEventUniqueGiftReceivedInBusinessAccount

inline fun <T> ChatEvent.ifGiftSentOrReceivedEventUniqueGiftReceivedInBusinessAccount(block: (GiftSentOrReceivedEvent.UniqueGift.ReceivedInBusinessAccount) -> T): T?

ifGiveawayCreated

inline fun <T> ChatEvent.ifGiveawayCreated(block: (GiveawayCreated) -> T): T?

ifGiveawayCreatedCompanion

inline fun <T> ChatEvent.ifGiveawayCreatedCompanion(block: (GiveawayCreated.Companion) -> T): T?

ifGiveawayCreatedStars

inline fun <T> ChatEvent.ifGiveawayCreatedStars(block: (GiveawayCreated.Stars) -> T): T?

ifGiveawayPrivateResults

inline fun <T> ChatEvent.ifGiveawayPrivateResults(block: (GiveawayPrivateResults) -> T): T?

ifGroupChatCreated

inline fun <T> ChatEvent.ifGroupChatCreated(block: (GroupChatCreated) -> T): T?

ifGroupEvent

inline fun <T> ChatEvent.ifGroupEvent(block: (GroupEvent) -> T): T?

ifLeftChatMemberEvent

inline fun <T> ChatEvent.ifLeftChatMemberEvent(block: (LeftChatMemberEvent) -> T): T?

ifManagedBotCreated

inline fun <T> ChatEvent.ifManagedBotCreated(block: (ManagedBotCreated) -> T): T?

ifMessageAutoDeleteTimerChanged

inline fun <T> ChatEvent.ifMessageAutoDeleteTimerChanged(block: (MessageAutoDeleteTimerChanged) -> T): T?

ifMigratedToSupergroup

inline fun <T> ChatEvent.ifMigratedToSupergroup(block: (MigratedToSupergroup) -> T): T?

ifNewChatMembers

inline fun <T> ChatEvent.ifNewChatMembers(block: (NewChatMembers) -> T): T?

ifNewChatPhoto

inline fun <T> ChatEvent.ifNewChatPhoto(block: (NewChatPhoto) -> T): T?

ifNewChatTitle

inline fun <T> ChatEvent.ifNewChatTitle(block: (NewChatTitle) -> T): T?

ifPaidMessagePriceChanged

inline fun <T> ChatEvent.ifPaidMessagePriceChanged(block: (PaidMessagePriceChanged) -> T): T?

ifPinnedMessage

inline fun <T> ChatEvent.ifPinnedMessage(block: (PinnedMessage) -> T): T?

ifPollOptionAdded

inline fun <T> ChatEvent.ifPollOptionAdded(block: (PollOptionAdded) -> T): T?

ifPollOptionDeleted

inline fun <T> ChatEvent.ifPollOptionDeleted(block: (PollOptionDeleted) -> T): T?

ifPrivateEvent

inline fun <T> ChatEvent.ifPrivateEvent(block: (PrivateEvent) -> T): T?

ifPrivateForumEvent

inline fun <T> ChatEvent.ifPrivateForumEvent(block: (PrivateForumEvent) -> T): T?

ifProximityAlertTriggered

inline fun <T> ChatEvent.ifProximityAlertTriggered(block: (ProximityAlertTriggered) -> T): T?

ifPublicChatEvent

inline fun <T> ChatEvent.ifPublicChatEvent(block: (PublicChatEvent) -> T): T?

ifRefundedPaymentEvent

inline fun <T> ChatEvent.ifRefundedPaymentEvent(block: (RefundedPaymentEvent) -> T): T?

ifSuccessfulPaymentEvent

inline fun <T> ChatEvent.ifSuccessfulPaymentEvent(block: (SuccessfulPaymentEvent) -> T): T?

ifSuggestedPostApprovalFailed

inline fun <T> ChatEvent.ifSuggestedPostApprovalFailed(block: (SuggestedPostApprovalFailed) -> T): T?

ifSuggestedPostApproved

inline fun <T> ChatEvent.ifSuggestedPostApproved(block: (SuggestedPostApproved) -> T): T?

ifSuggestedPostDeclined

inline fun <T> ChatEvent.ifSuggestedPostDeclined(block: (SuggestedPostDeclined) -> T): T?

ifSuggestedPostPaid

inline fun <T> ChatEvent.ifSuggestedPostPaid(block: (SuggestedPostPaid) -> T): T?

ifSuggestedPostPaidOther

inline fun <T> ChatEvent.ifSuggestedPostPaidOther(block: (SuggestedPostPaid.Other) -> T): T?

ifSuggestedPostPaidTON

inline fun <T> ChatEvent.ifSuggestedPostPaidTON(block: (SuggestedPostPaid.TON) -> T): T?

ifSuggestedPostPaidXTR

inline fun <T> ChatEvent.ifSuggestedPostPaidXTR(block: (SuggestedPostPaid.XTR) -> T): T?

ifSuggestedPostRefunded

inline fun <T> ChatEvent.ifSuggestedPostRefunded(block: (SuggestedPostRefunded) -> T): T?

ifSupergroupChatCreated

inline fun <T> ChatEvent.ifSupergroupChatCreated(block: (SupergroupChatCreated) -> T): T?

ifSupergroupEvent

inline fun <T> ChatEvent.ifSupergroupEvent(block: (SupergroupEvent) -> T): T?

ifUserLoggedIn

inline fun <T> ChatEvent.ifUserLoggedIn(block: (UserLoggedIn) -> T): T?

ifUsersShared

inline fun <T> ChatEvent.ifUsersShared(block: (UsersShared) -> T): T?

ifVideoChatEnded

inline fun <T> ChatEvent.ifVideoChatEnded(block: (VideoChatEnded) -> T): T?

ifVideoChatEvent

inline fun <T> ChatEvent.ifVideoChatEvent(block: (VideoChatEvent) -> T): T?

ifVideoChatParticipantsInvited

inline fun <T> ChatEvent.ifVideoChatParticipantsInvited(block: (VideoChatParticipantsInvited) -> T): T?

ifVideoChatScheduled

inline fun <T> ChatEvent.ifVideoChatScheduled(block: (VideoChatScheduled) -> T): T?

ifVideoChatStarted

inline fun <T> ChatEvent.ifVideoChatStarted(block: (VideoChatStarted) -> T): T?

ifWebAppData

inline fun <T> ChatEvent.ifWebAppData(block: (WebAppData) -> T): T?

ifWriteAccessAllowed

inline fun <T> ChatEvent.ifWriteAccessAllowed(block: (WriteAccessAllowed) -> T): T?

ifWriteAccessAllowedFromAttachmentMenu

inline fun <T> ChatEvent.ifWriteAccessAllowedFromAttachmentMenu(block: (WriteAccessAllowed.FromAttachmentMenu) -> T): T?

ifWriteAccessAllowedFromRequest

inline fun <T> ChatEvent.ifWriteAccessAllowedFromRequest(block: (WriteAccessAllowed.FromRequest) -> T): T?

ifWriteAccessAllowedFromWebAppLink

inline fun <T> ChatEvent.ifWriteAccessAllowedFromWebAppLink(block: (WriteAccessAllowed.FromWebAppLink) -> T): T?

ifWriteAccessAllowedOther

inline fun <T> ChatEvent.ifWriteAccessAllowedOther(block: (WriteAccessAllowed.Other) -> T): T?

leftChatMemberEventOrNull

inline fun ChatEvent.leftChatMemberEventOrNull(): LeftChatMemberEvent?

leftChatMemberEventOrThrow

inline fun ChatEvent.leftChatMemberEventOrThrow(): LeftChatMemberEvent

managedBotCreatedOrNull

inline fun ChatEvent.managedBotCreatedOrNull(): ManagedBotCreated?

managedBotCreatedOrThrow

inline fun ChatEvent.managedBotCreatedOrThrow(): ManagedBotCreated

messageAutoDeleteTimerChangedOrNull

inline fun ChatEvent.messageAutoDeleteTimerChangedOrNull(): MessageAutoDeleteTimerChanged?

messageAutoDeleteTimerChangedOrThrow

inline fun ChatEvent.messageAutoDeleteTimerChangedOrThrow(): MessageAutoDeleteTimerChanged

migratedToSupergroupOrNull

inline fun ChatEvent.migratedToSupergroupOrNull(): MigratedToSupergroup?

migratedToSupergroupOrThrow

inline fun ChatEvent.migratedToSupergroupOrThrow(): MigratedToSupergroup

newChatMembersOrNull

inline fun ChatEvent.newChatMembersOrNull(): NewChatMembers?

newChatMembersOrThrow

inline fun ChatEvent.newChatMembersOrThrow(): NewChatMembers

newChatPhotoOrNull

inline fun ChatEvent.newChatPhotoOrNull(): NewChatPhoto?

newChatPhotoOrThrow

inline fun ChatEvent.newChatPhotoOrThrow(): NewChatPhoto

newChatTitleOrNull

inline fun ChatEvent.newChatTitleOrNull(): NewChatTitle?

newChatTitleOrThrow

inline fun ChatEvent.newChatTitleOrThrow(): NewChatTitle

paidMessagePriceChangedOrNull

inline fun ChatEvent.paidMessagePriceChangedOrNull(): PaidMessagePriceChanged?

paidMessagePriceChangedOrThrow

inline fun ChatEvent.paidMessagePriceChangedOrThrow(): PaidMessagePriceChanged

parseCommandsWithArgs

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

fun TextedWithTextSources.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 TextedWithTextSources.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>>>

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

pinnedMessageOrNull