docs/dev.inmo.tgbotapi.types.gifts/OwnedGift/Regular

Regular

@Serializable(with = OwnedGift.Regular.Companion::class)

sealed interface Regular : OwnedGift, TextedInput(source)

Inheritors

Common

OwnedByBusinessAccount

Types

Common

@Serializable

data class Common(val gift: Gift.Regular, val sendDate: TelegramDate, val senderUser: PreviewUser? = null, val text: String? = null, entities: RawMessageEntities? = null, val isPrivate: Boolean = false, val isSaved: Boolean = false, val canBeUpgraded: Boolean = false, val wasRefunded: Boolean = false, val convertStarCount: Int? = null, val prepaidUpgradeStarCount: Int? = null, val isUpgradeSeparate: Boolean = false, val uniqueGiftNumber: Int? = null) : OwnedGift.Regular, OwnedGift.Common

Companion

object Companion : KSerializer<OwnedGift.Regular>

OwnedByBusinessAccount

@Serializable

data class OwnedByBusinessAccount(val gift: Gift.Regular, val sendDate: TelegramDate, val ownedGiftId: GiftId, val senderUser: PreviewUser? = null, val text: String? = null, entities: RawMessageEntities? = null, val isPrivate: Boolean = false, val isSaved: Boolean = false, val canBeUpgraded: Boolean = false, val wasRefunded: Boolean = false, val convertStarCount: Int? = null, val prepaidUpgradeStarCount: Int? = null, val isUpgradeSeparate: Boolean = false, val uniqueGiftNumber: Int? = null) : OwnedGift.Regular, OwnedGift.OwnedByBusinessAccount

Properties

canBeUpgraded

abstract val canBeUpgraded: Boolean

convertStarCount

abstract val convertStarCount: Int?

gift

abstract override val gift: Gift.Regular

isPrivate

abstract val isPrivate: Boolean

isSaved

abstract val isSaved: Boolean

isUpgradeSeparate

abstract val isUpgradeSeparate: Boolean

ownedGiftId

abstract val ownedGiftId: GiftId?

prepaidUpgradeStarCount

abstract val prepaidUpgradeStarCount: Int?

sendDate

abstract val sendDate: TelegramDate

senderUser

abstract val senderUser: PreviewUser?

text

abstract val text: String?

textSources

abstract override val textSources: List<TextSource>

Full list of TextSources

uniqueGiftNumber

abstract val uniqueGiftNumber: Int?

wasRefunded

abstract val wasRefunded: Boolean

Functions

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: