docs/dev.inmo.tgbotapi.types.message.content/AnimationContent

AnimationContent

@Serializable

data class AnimationContent(val media: AnimationFile, val includedDocument: DocumentFile?, val text: String?, val textSources: TextSourcesList = emptyList(), val spoilered: Boolean = false, val quote: TextQuote? = null, val showCaptionAboveMedia: Boolean = false) : TextedMediaContent, SpoilerableMediaContent, WithCustomizedCaptionMediaContent(source)

Constructors

AnimationContent

constructor(media: AnimationFile, includedDocument: DocumentFile?, text: String?, textSources: TextSourcesList = emptyList(), spoilered: Boolean = false, quote: TextQuote? = null, showCaptionAboveMedia: Boolean = false)

Properties

includedDocument

val includedDocument: DocumentFile?

media

open override val media: AnimationFile

quote

open override val quote: TextQuote?

showCaptionAboveMedia

open override val showCaptionAboveMedia: Boolean

spoilered

open override val spoilered: Boolean

text

open override val text: String?

textSources

open override val textSources: TextSourcesList

Full list of TextSources

Functions

animationContentOrNull

inline fun ResendableContent.animationContentOrNull(): AnimationContent?

animationContentOrThrow

inline fun ResendableContent.animationContentOrThrow(): AnimationContent

asAnimationContent

inline fun ResendableContent.asAnimationContent(): AnimationContent?

asAudioContent

inline fun ResendableContent.asAudioContent(): AudioContent?

asAudioMediaGroupContent

inline fun ResendableContent.asAudioMediaGroupContent(): AudioMediaGroupPartContent?

asContactContent

inline fun ResendableContent.asContactContent(): ContactContent?

asDiceContent

inline fun ResendableContent.asDiceContent(): DiceContent?

asDocumentContent

inline fun ResendableContent.asDocumentContent(): DocumentContent?

inline fun MediaContent.asDocumentContent(): DocumentContent

asDocumentMediaGroupContent

inline fun ResendableContent.asDocumentMediaGroupContent(): DocumentMediaGroupPartContent?

asGameContent

inline fun ResendableContent.asGameContent(): GameContent?

asInvoiceContent

inline fun ResendableContent.asInvoiceContent(): InvoiceContent?

asLiveLocationContent

inline fun ResendableContent.asLiveLocationContent(): LiveLocationContent?

asLocationContent

inline fun ResendableContent.asLocationContent(): LocationContent?

asMediaCollectionContent

inline fun ResendableContent.asMediaCollectionContent(): MediaCollectionContent<TelegramMediaFile>?

asMediaContent

inline fun ResendableContent.asMediaContent(): MediaContent?

asMediaGroupContent

inline fun ResendableContent.asMediaGroupContent(): MediaGroupPartContent?

asMessageContent

inline fun ResendableContent.asMessageContent(): MessageContent?

asPhotoContent

inline fun ResendableContent.asPhotoContent(): PhotoContent?

asPollContent

inline fun ResendableContent.asPollContent(): PollContent?

asStaticLocationContent

inline fun ResendableContent.asStaticLocationContent(): StaticLocationContent?

asStickerContent

inline fun ResendableContent.asStickerContent(): StickerContent?

asTelegramMedia

open override fun asTelegramMedia(): TelegramMediaAnimation

asTextContent

inline fun ResendableContent.asTextContent(): TextContent?

asTextedInput

inline fun MessageContent.asTextedInput(): TextedInput?

asTextedMediaContent

inline fun ResendableContent.asTextedMediaContent(): TextedMediaContent?

asVenueContent

inline fun ResendableContent.asVenueContent(): VenueContent?

asVideoContent

inline fun ResendableContent.asVideoContent(): VideoContent?

asVideoNoteContent

inline fun ResendableContent.asVideoNoteContent(): VideoNoteContent?

asVisualMediaGroupContent

inline fun ResendableContent.asVisualMediaGroupContent(): VisualMediaGroupPartContent?

asVoiceContent

inline fun ResendableContent.asVoiceContent(): VoiceContent?

audioContentOrNull

inline fun ResendableContent.audioContentOrNull(): AudioContent?

audioContentOrThrow

inline fun ResendableContent.audioContentOrThrow(): AudioContent

audioMediaGroupPartContentOrNull

inline fun ResendableContent.audioMediaGroupPartContentOrNull(): AudioMediaGroupPartContent?

audioMediaGroupPartContentOrThrow

inline fun ResendableContent.audioMediaGroupPartContentOrThrow(): AudioMediaGroupPartContent

checklistContentOrNull

inline fun ResendableContent.checklistContentOrNull(): ChecklistContent?

checklistContentOrThrow

inline fun ResendableContent.checklistContentOrThrow(): ChecklistContent

contactContentOrNull

inline fun ResendableContent.contactContentOrNull(): ContactContent?

contactContentOrThrow

inline fun ResendableContent.contactContentOrThrow(): ContactContent

createResend

open override fun createResend(chatId: ChatIdentifier, messageThreadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyParameters: ReplyParameters? = null, replyMarkup: KeyboardMarkup? = null): Request<ChatContentMessage<AnimationContent>>

open fun createResend(chatId: ChatIdentifier, messageThreadId: MessageThreadId? = chatId.threadId, directMessageThreadId: DirectMessageThreadId? = chatId.directMessageThreadId, businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, suggestedPostParameters: SuggestedPostParameters? = null, replyToMessageId: MessageId?, allowSendingWithoutReply: Boolean? = null, replyMarkup: KeyboardMarkup? = null): Request<out ChatMessage>

diceContentOrNull

inline fun ResendableContent.diceContentOrNull(): DiceContent?

diceContentOrThrow

inline fun ResendableContent.diceContentOrThrow(): DiceContent

documentContentOrNull

inline fun ResendableContent.documentContentOrNull(): DocumentContent?

documentContentOrThrow

inline fun ResendableContent.documentContentOrThrow(): DocumentContent

documentMediaGroupPartContentOrNull

inline fun ResendableContent.documentMediaGroupPartContentOrNull(): DocumentMediaGroupPartContent?

documentMediaGroupPartContentOrThrow

inline fun ResendableContent.documentMediaGroupPartContentOrThrow(): DocumentMediaGroupPartContent

gameContentOrNull

inline fun ResendableContent.gameContentOrNull(): GameContent?

gameContentOrThrow

inline fun ResendableContent.gameContentOrThrow(): GameContent

giveawayContentOrNull

inline fun ResendableContent.giveawayContentOrNull(): GiveawayContent?

giveawayContentOrThrow

inline fun ResendableContent.giveawayContentOrThrow(): GiveawayContent

giveawayPublicResultsContentOrNull

inline fun ResendableContent.giveawayPublicResultsContentOrNull(): GiveawayPublicResultsContent?

giveawayPublicResultsContentOrThrow

inline fun ResendableContent.giveawayPublicResultsContentOrThrow(): GiveawayPublicResultsContent

ifAnimationContent

inline fun <T> ResendableContent.ifAnimationContent(block: (AnimationContent) -> T): T?

ifAudioContent

inline fun <T> ResendableContent.ifAudioContent(block: (AudioContent) -> T): T?

ifAudioMediaGroupPartContent

inline fun <T> ResendableContent.ifAudioMediaGroupPartContent(block: (AudioMediaGroupPartContent) -> T): T?

ifChecklistContent

inline fun <T> ResendableContent.ifChecklistContent(block: (ChecklistContent) -> T): T?

ifContactContent

inline fun <T> ResendableContent.ifContactContent(block: (ContactContent) -> T): T?

ifDiceContent

inline fun <T> ResendableContent.ifDiceContent(block: (DiceContent) -> T): T?

ifDocumentContent

inline fun <T> ResendableContent.ifDocumentContent(block: (DocumentContent) -> T): T?

ifDocumentMediaGroupPartContent

inline fun <T> ResendableContent.ifDocumentMediaGroupPartContent(block: (DocumentMediaGroupPartContent) -> T): T?

ifGameContent

inline fun <T> ResendableContent.ifGameContent(block: (GameContent) -> T): T?

ifGiveawayContent

inline fun <T> ResendableContent.ifGiveawayContent(block: (GiveawayContent) -> T): T?

ifGiveawayPublicResultsContent

inline fun <T> ResendableContent.ifGiveawayPublicResultsContent(block: (GiveawayPublicResultsContent) -> T): T?

ifInvoiceContent

inline fun <T> ResendableContent.ifInvoiceContent(block: (InvoiceContent) -> T): T?

ifLiveLocationContent

inline fun <T> ResendableContent.ifLiveLocationContent(block: (LiveLocationContent) -> T): T?

ifLivePhotoContent

inline fun <T> ResendableContent.ifLivePhotoContent(block: (LivePhotoContent) -> T): T?

ifLocationContent

inline fun <T> ResendableContent.ifLocationContent(block: (LocationContent) -> T): T?

ifMediaCollectionContent

inline fun <T> ResendableContent.ifMediaCollectionContent(block: (MediaCollectionContent<TelegramMediaFile>) -> T): T?

ifMediaContent

inline fun <T> ResendableContent.ifMediaContent(block: (MediaContent) -> T): T?

ifMediaGroupCollectionContent

inline fun <T> ResendableContent.ifMediaGroupCollectionContent(block: (MediaGroupCollectionContent<MediaGroupPartContent>) -> T): T?

ifMediaGroupContent

inline fun <T> ResendableContent.ifMediaGroupContent(block: (MediaGroupContent<MediaGroupPartContent>) -> T): T?

ifMediaGroupPartContent

inline fun <T> ResendableContent.ifMediaGroupPartContent(block: (MediaGroupPartContent) -> T): T?

ifMessageContent

inline fun <T> ResendableContent.ifMessageContent(block: (MessageContent) -> T): T?

ifPaidMediaInfoContent

inline fun <T> ResendableContent.ifPaidMediaInfoContent(block: (PaidMediaInfoContent) -> T): T?

ifPhotoContent

inline fun <T> ResendableContent.ifPhotoContent(block: (PhotoContent) -> T): T?

ifPollContent

inline fun <T> ResendableContent.ifPollContent(block: (PollContent) -> T): T?

ifRichMessageContent

inline fun <T> ResendableContent.ifRichMessageContent(block: (RichMessageContent) -> T): T?

ifSpoilerableMediaContent

inline fun <T> ResendableContent.ifSpoilerableMediaContent(block: (SpoilerableMediaContent) -> T): T?

ifStaticLocationContent

inline fun <T> ResendableContent.ifStaticLocationContent(block: (StaticLocationContent) -> T): T?

ifStickerContent

inline fun <T> ResendableContent.ifStickerContent(block: (StickerContent) -> T): T?

ifStoryContent

inline fun <T> ResendableContent.ifStoryContent(block: (StoryContent) -> T): T?

ifTextContent

inline fun <T> ResendableContent.ifTextContent(block: (TextContent) -> T): T?

ifTextedContent

inline fun <T> ResendableContent.ifTextedContent(block: (TextedContent) -> T): T?

ifTextedMediaContent

inline fun <T> ResendableContent.ifTextedMediaContent(block: (TextedMediaContent) -> T): T?

ifVenueContent

inline fun <T> ResendableContent.ifVenueContent(block: (VenueContent) -> T): T?

ifVideoContent

inline fun <T> ResendableContent.ifVideoContent(block: (VideoContent) -> T): T?

ifVideoNoteContent

inline fun <T> ResendableContent.ifVideoNoteContent(block: (VideoNoteContent) -> T): T?

ifVisualMediaGroupPartContent

inline fun <T> ResendableContent.ifVisualMediaGroupPartContent(block: (VisualMediaGroupPartContent) -> T): T?

ifVoiceContent

inline fun <T> ResendableContent.ifVoiceContent(block: (VoiceContent) -> T): T?

ifWithCustomizedCaptionMediaContent

inline fun <T> ResendableContent.ifWithCustomizedCaptionMediaContent(block: (WithCustomizedCaptionMediaContent) -> T): T?

invoiceContentOrNull

inline fun ResendableContent.invoiceContentOrNull(): InvoiceContent?

invoiceContentOrThrow

inline fun ResendableContent.invoiceContentOrThrow(): InvoiceContent

isWithMention

fun TextedContent.isWithMention(username: Username): Boolean

Check, that TextedContent.textSources contains:

fun TextedContent.isWithMention(user: User): Boolean

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

isWithTextMention

fun TextedContent.isWithTextMention(userId: UserId): Boolean

Check, that TextedContent.textSources contains:

liveLocationContentOrNull

inline fun ResendableContent.liveLocationContentOrNull(): LiveLocationContent?

liveLocationContentOrThrow

inline fun ResendableContent.liveLocationContentOrThrow(): LiveLocationContent

livePhotoContentOrNull

inline fun ResendableContent.livePhotoContentOrNull(): LivePhotoContent?

livePhotoContentOrThrow

inline fun ResendableContent.livePhotoContentOrThrow(): LivePhotoContent

locationContentOrNull

inline fun ResendableContent.locationContentOrNull(): LocationContent?

locationContentOrThrow

inline fun ResendableContent.locationContentOrThrow(): LocationContent

mediaCollectionContentOrNull

inline fun ResendableContent.mediaCollectionContentOrNull(): MediaCollectionContent<TelegramMediaFile>?

mediaCollectionContentOrThrow

inline fun ResendableContent.mediaCollectionContentOrThrow(): MediaCollectionContent<TelegramMediaFile>

mediaContentOrNull

inline fun ResendableContent.mediaContentOrNull(): MediaContent?

mediaContentOrThrow

inline fun ResendableContent.mediaContentOrThrow(): MediaContent

mediaGroupCollectionContentOrNull

inline fun ResendableContent.mediaGroupCollectionContentOrNull(): MediaGroupCollectionContent<MediaGroupPartContent>?

mediaGroupCollectionContentOrThrow

inline fun ResendableContent.mediaGroupCollectionContentOrThrow(): MediaGroupCollectionContent<MediaGroupPartContent>

mediaGroupContentOrNull

inline fun ResendableContent.mediaGroupContentOrNull(): MediaGroupContent<MediaGroupPartContent>?

mediaGroupContentOrThrow

inline fun ResendableContent.mediaGroupContentOrThrow(): MediaGroupContent<MediaGroupPartContent>

mediaGroupPartContentOrNull

inline fun ResendableContent.mediaGroupPartContentOrNull(): MediaGroupPartContent?

mediaGroupPartContentOrThrow

inline fun ResendableContent.mediaGroupPartContentOrThrow(): MediaGroupPartContent

messageContentOrNull

inline fun ResendableContent.messageContentOrNull(): MessageContent?

messageContentOrThrow

inline fun ResendableContent.messageContentOrThrow(): MessageContent

paidMediaInfoContentOrNull

inline fun ResendableContent.paidMediaInfoContentOrNull(): PaidMediaInfoContent?

paidMediaInfoContentOrThrow

inline fun ResendableContent.paidMediaInfoContentOrThrow(): PaidMediaInfoContent

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:

photoContentOrNull