docs/dev.inmo.tgbotapi.types.media/TelegramMediaAudio

TelegramMediaAudio

@Serializable

data class TelegramMediaAudio : TelegramFreeMedia, AudioMediaGroupMemberTelegramMedia, DuratedTelegramMedia, ThumbedTelegramMedia, TitledTelegramMedia, Performerable, InputPollMedia(source)

Types

object Companion

Properties

open override val duration: Long?

open val entities: List<TextSource>?

open override val file: InputFile

@SerialName(value = "media")

open override val media: String

@SerialName(value = "parse_mode")

open override val parseMode: ParseMode?

open override val performer: String?

@SerialName(value = "caption")

open override val text: String?

open override val textSources: TextSourcesList?

Full list of TextSources

open override val thumb: InputFile?

open override val title: String?

@EncodeDefault

open override val type: String

Functions

asAudioMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.asAudioMediaGroupMemberTelegramMedia(): AudioMediaGroupMemberTelegramMedia?

asDocumentMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.asDocumentMediaGroupMemberTelegramMedia(): DocumentMediaGroupMemberTelegramMedia?

asDuratedTelegramMedia

inline fun TelegramFreeMedia.asDuratedTelegramMedia(): DuratedTelegramMedia?

asMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.asMediaGroupMemberTelegramMedia(): MediaGroupMemberTelegramMedia?

asSizedTelegramMedia

inline fun TelegramFreeMedia.asSizedTelegramMedia(): SizedTelegramMedia?

asTelegramMediaAnimation

inline fun TelegramFreeMedia.asTelegramMediaAnimation(): TelegramMediaAnimation?

asTelegramMediaAudio

inline fun TelegramFreeMedia.asTelegramMediaAudio(): TelegramMediaAudio?

asTelegramMediaDocument

inline fun TelegramFreeMedia.asTelegramMediaDocument(): TelegramMediaDocument?

asTelegramMediaPhoto

inline fun TelegramFreeMedia.asTelegramMediaPhoto(): TelegramMediaPhoto?

asTelegramMediaVideo

inline fun TelegramFreeMedia.asTelegramMediaVideo(): TelegramMediaVideo?

asThumbedTelegramMedia

inline fun TelegramFreeMedia.asThumbedTelegramMedia(): ThumbedTelegramMedia?

asTitledTelegramMedia

inline fun TelegramFreeMedia.asTitledTelegramMedia(): TitledTelegramMedia?

asVisualMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.asVisualMediaGroupMemberTelegramMedia(): VisualMediaGroupMemberTelegramMedia?

audioMediaGroupMemberTelegramMediaOrNull

inline fun TelegramMedia.audioMediaGroupMemberTelegramMediaOrNull(): AudioMediaGroupMemberTelegramMedia?

audioMediaGroupMemberTelegramMediaOrThrow

inline fun TelegramMedia.audioMediaGroupMemberTelegramMediaOrThrow(): AudioMediaGroupMemberTelegramMedia

coveredTelegramMediaOrNull

inline fun TelegramMedia.coveredTelegramMediaOrNull(): CoveredTelegramMedia?

coveredTelegramMediaOrThrow

inline fun TelegramMedia.coveredTelegramMediaOrThrow(): CoveredTelegramMedia

documentMediaGroupMemberTelegramMediaOrNull

inline fun TelegramMedia.documentMediaGroupMemberTelegramMediaOrNull(): DocumentMediaGroupMemberTelegramMedia?

documentMediaGroupMemberTelegramMediaOrThrow

inline fun TelegramMedia.documentMediaGroupMemberTelegramMediaOrThrow(): DocumentMediaGroupMemberTelegramMedia

duratedTelegramMediaOrNull

inline fun TelegramMedia.duratedTelegramMediaOrNull(): DuratedTelegramMedia?

duratedTelegramMediaOrThrow

inline fun TelegramMedia.duratedTelegramMediaOrThrow(): DuratedTelegramMedia

ifAudioMediaGroupMemberTelegramMedia

inline fun <T> TelegramMedia.ifAudioMediaGroupMemberTelegramMedia(block: (AudioMediaGroupMemberTelegramMedia) -> T): T?

ifCoveredTelegramMedia

inline fun <T> TelegramMedia.ifCoveredTelegramMedia(block: (CoveredTelegramMedia) -> T): T?

ifDocumentMediaGroupMemberTelegramMedia

inline fun <T> TelegramMedia.ifDocumentMediaGroupMemberTelegramMedia(block: (DocumentMediaGroupMemberTelegramMedia) -> T): T?

ifDuratedTelegramMedia

inline fun <T> TelegramMedia.ifDuratedTelegramMedia(block: (DuratedTelegramMedia) -> T): T?

ifMediaGroupMemberTelegramMedia

inline fun <T> TelegramMedia.ifMediaGroupMemberTelegramMedia(block: (MediaGroupMemberTelegramMedia) -> T): T?

ifSizedTelegramMedia

inline fun <T> TelegramMedia.ifSizedTelegramMedia(block: (SizedTelegramMedia) -> T): T?

ifSpoilerableTelegramMedia

inline fun <T> TelegramMedia.ifSpoilerableTelegramMedia(block: (SpoilerableTelegramMedia) -> T): T?

ifTelegramFreeMedia

inline fun <T> TelegramMedia.ifTelegramFreeMedia(block: (TelegramFreeMedia) -> T): T?

ifTelegramMediaAnimation

inline fun <T> InputPollMedia.ifTelegramMediaAnimation(block: (TelegramMediaAnimation) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaAnimation(block: (TelegramMediaAnimation) -> T): T?

ifTelegramMediaAudio

inline fun <T> InputPollMedia.ifTelegramMediaAudio(block: (TelegramMediaAudio) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaAudio(block: (TelegramMediaAudio) -> T): T?

ifTelegramMediaDocument

inline fun <T> InputPollMedia.ifTelegramMediaDocument(block: (TelegramMediaDocument) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaDocument(block: (TelegramMediaDocument) -> T): T?

ifTelegramMediaLivePhoto

inline fun <T> InputPollMedia.ifTelegramMediaLivePhoto(block: (TelegramMediaLivePhoto) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaLivePhoto(block: (TelegramMediaLivePhoto) -> T): T?

ifTelegramMediaLocation

inline fun <T> InputPollMedia.ifTelegramMediaLocation(block: (TelegramMediaLocation) -> T): T?

ifTelegramMediaPhoto

inline fun <T> InputPollMedia.ifTelegramMediaPhoto(block: (TelegramMediaPhoto) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaPhoto(block: (TelegramMediaPhoto) -> T): T?

ifTelegramMediaSticker

inline fun <T> TelegramMedia.ifTelegramMediaSticker(block: (TelegramMediaSticker) -> T): T?

ifTelegramMediaVenue

inline fun <T> InputPollMedia.ifTelegramMediaVenue(block: (TelegramMediaVenue) -> T): T?

ifTelegramMediaVideo

inline fun <T> InputPollMedia.ifTelegramMediaVideo(block: (TelegramMediaVideo) -> T): T?

inline fun <T> TelegramMedia.ifTelegramMediaVideo(block: (TelegramMediaVideo) -> T): T?

ifTelegramPaidMedia

inline fun <T> TelegramMedia.ifTelegramPaidMedia(block: (TelegramPaidMedia) -> T): T?

ifTelegramPaidMediaLivePhoto

inline fun <T> TelegramMedia.ifTelegramPaidMediaLivePhoto(block: (TelegramPaidMediaLivePhoto) -> T): T?

ifTelegramPaidMediaPhoto

inline fun <T> TelegramMedia.ifTelegramPaidMediaPhoto(block: (TelegramPaidMediaPhoto) -> T): T?

ifTelegramPaidMediaVideo

inline fun <T> TelegramMedia.ifTelegramPaidMediaVideo(block: (TelegramPaidMediaVideo) -> T): T?

ifThumbedTelegramMedia

inline fun <T> TelegramMedia.ifThumbedTelegramMedia(block: (ThumbedTelegramMedia) -> T): T?

ifTitledTelegramMedia

inline fun <T> TelegramMedia.ifTitledTelegramMedia(block: (TitledTelegramMedia) -> T): T?

ifVisualMediaGroupMemberTelegramMedia

inline fun <T> TelegramMedia.ifVisualMediaGroupMemberTelegramMedia(block: (VisualMediaGroupMemberTelegramMedia) -> T): T?

ifVisualTelegramPaidMedia

inline fun <T> TelegramMedia.ifVisualTelegramPaidMedia(block: (VisualTelegramPaidMedia) -> T): T?

ifWithCustomizableCaptionTelegramMedia

inline fun <T> TelegramMedia.ifWithCustomizableCaptionTelegramMedia(block: (WithCustomizableCaptionTelegramMedia) -> T): T?

ifWithCustomStartTelegramMedia

inline fun <T> TelegramMedia.ifWithCustomStartTelegramMedia(block: (WithCustomStartTelegramMedia) -> T): T?

mediaGroupMemberTelegramMediaOrNull

inline fun TelegramMedia.mediaGroupMemberTelegramMediaOrNull(): MediaGroupMemberTelegramMedia?

mediaGroupMemberTelegramMediaOrThrow

inline fun TelegramMedia.mediaGroupMemberTelegramMediaOrThrow(): MediaGroupMemberTelegramMedia

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:

requireAudioMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.requireAudioMediaGroupMemberTelegramMedia(): AudioMediaGroupMemberTelegramMedia

requireDocumentMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.requireDocumentMediaGroupMemberTelegramMedia(): DocumentMediaGroupMemberTelegramMedia

requireDuratedTelegramMedia

inline fun TelegramFreeMedia.requireDuratedTelegramMedia(): DuratedTelegramMedia

requireMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.requireMediaGroupMemberTelegramMedia(): MediaGroupMemberTelegramMedia

requireSizedTelegramMedia

inline fun TelegramFreeMedia.requireSizedTelegramMedia(): SizedTelegramMedia

requireTelegramMediaAnimation

inline fun TelegramFreeMedia.requireTelegramMediaAnimation(): TelegramMediaAnimation

requireTelegramMediaAudio

inline fun TelegramFreeMedia.requireTelegramMediaAudio(): TelegramMediaAudio

requireTelegramMediaDocument

inline fun TelegramFreeMedia.requireTelegramMediaDocument(): TelegramMediaDocument

requireTelegramMediaPhoto

inline fun TelegramFreeMedia.requireTelegramMediaPhoto(): TelegramMediaPhoto

requireTelegramMediaVideo

inline fun TelegramFreeMedia.requireTelegramMediaVideo(): TelegramMediaVideo

requireThumbedTelegramMedia

inline fun TelegramFreeMedia.requireThumbedTelegramMedia(): ThumbedTelegramMedia

requireTitledTelegramMedia

inline fun TelegramFreeMedia.requireTitledTelegramMedia(): TitledTelegramMedia

requireVisualMediaGroupMemberTelegramMedia

inline fun TelegramFreeMedia.requireVisualMediaGroupMemberTelegramMedia(): VisualMediaGroupMemberTelegramMedia

open override fun serialize(format: StringFormat): String

sizedTelegramMediaOrNull

inline fun TelegramMedia.sizedTelegramMediaOrNull(): SizedTelegramMedia?

sizedTelegramMediaOrThrow

inline fun TelegramMedia.sizedTelegramMediaOrThrow(): SizedTelegramMedia

spoilerableTelegramMediaOrNull

inline fun TelegramMedia.spoilerableTelegramMediaOrNull(): SpoilerableTelegramMedia?

spoilerableTelegramMediaOrThrow

inline fun TelegramMedia.spoilerableTelegramMediaOrThrow(): SpoilerableTelegramMedia

telegramFreeMediaOrNull

inline fun TelegramMedia.telegramFreeMediaOrNull(): TelegramFreeMedia?

telegramFreeMediaOrThrow

inline fun TelegramMedia.telegramFreeMediaOrThrow(): TelegramFreeMedia

telegramMediaAnimationOrNull

inline fun InputPollMedia.telegramMediaAnimationOrNull(): TelegramMediaAnimation?

inline fun TelegramMedia.telegramMediaAnimationOrNull(): TelegramMediaAnimation?

telegramMediaAnimationOrThrow

inline fun InputPollMedia.telegramMediaAnimationOrThrow(): TelegramMediaAnimation

inline fun TelegramMedia.telegramMediaAnimationOrThrow(): TelegramMediaAnimation

telegramMediaAudioOrNull

inline fun InputPollMedia.telegramMediaAudioOrNull(): TelegramMediaAudio?

inline fun TelegramMedia.telegramMediaAudioOrNull(): TelegramMediaAudio?

telegramMediaAudioOrThrow

inline fun InputPollMedia.telegramMediaAudioOrThrow(): TelegramMediaAudio

inline fun TelegramMedia.telegramMediaAudioOrThrow(): TelegramMediaAudio

telegramMediaDocumentOrNull

inline fun InputPollMedia.telegramMediaDocumentOrNull(): TelegramMediaDocument?

inline fun TelegramMedia.telegramMediaDocumentOrNull(): TelegramMediaDocument?

telegramMediaDocumentOrThrow

inline fun InputPollMedia.telegramMediaDocumentOrThrow(): TelegramMediaDocument

inline fun TelegramMedia.telegramMediaDocumentOrThrow(): TelegramMediaDocument

telegramMediaLivePhotoOrNull

inline fun InputPollMedia.telegramMediaLivePhotoOrNull(): TelegramMediaLivePhoto?

inline fun TelegramMedia.telegramMediaLivePhotoOrNull(): TelegramMediaLivePhoto?

telegramMediaLivePhotoOrThrow

inline fun InputPollMedia.telegramMediaLivePhotoOrThrow(): TelegramMediaLivePhoto

inline fun TelegramMedia.telegramMediaLivePhotoOrThrow(): TelegramMediaLivePhoto

telegramMediaLocationOrNull

inline fun InputPollMedia.telegramMediaLocationOrNull(): TelegramMediaLocation?

telegramMediaLocationOrThrow

inline fun InputPollMedia.telegramMediaLocationOrThrow(): TelegramMediaLocation

telegramMediaPhotoOrNull

inline fun InputPollMedia.telegramMediaPhotoOrNull(): TelegramMediaPhoto?

inline fun TelegramMedia.telegramMediaPhotoOrNull(): TelegramMediaPhoto?

telegramMediaPhotoOrThrow

inline fun InputPollMedia.telegramMediaPhotoOrThrow(): TelegramMediaPhoto

inline fun TelegramMedia.telegramMediaPhotoOrThrow(): TelegramMediaPhoto

telegramMediaStickerOrNull

inline fun TelegramMedia.telegramMediaStickerOrNull(): TelegramMediaSticker?

telegramMediaStickerOrThrow

inline fun TelegramMedia.telegramMediaStickerOrThrow(): TelegramMediaSticker

telegramMediaVenueOrNull

inline fun InputPollMedia.telegramMediaVenueOrNull(): TelegramMediaVenue?

telegramMediaVenueOrThrow

inline fun InputPollMedia.telegramMediaVenueOrThrow(): TelegramMediaVenue

telegramMediaVideoOrNull

inline fun InputPollMedia.telegramMediaVideoOrNull(): TelegramMediaVideo?

inline fun TelegramMedia.telegramMediaVideoOrNull(): TelegramMediaVideo?

telegramMediaVideoOrThrow

inline fun InputPollMedia.telegramMediaVideoOrThrow(): TelegramMediaVideo

inline fun TelegramMedia.telegramMediaVideoOrThrow(): TelegramMediaVideo

telegramPaidMediaLivePhotoOrNull

inline fun TelegramMedia.telegramPaidMediaLivePhotoOrNull(): TelegramPaidMediaLivePhoto?

telegramPaidMediaLivePhotoOrThrow

inline fun TelegramMedia.telegramPaidMediaLivePhotoOrThrow(): TelegramPaidMediaLivePhoto

telegramPaidMediaOrNull

inline fun TelegramMedia.telegramPaidMediaOrNull(): TelegramPaidMedia?

telegramPaidMediaOrThrow

inline fun TelegramMedia.telegramPaidMediaOrThrow(): TelegramPaidMedia

telegramPaidMediaPhotoOrNull

inline fun TelegramMedia.telegramPaidMediaPhotoOrNull(): TelegramPaidMediaPhoto?

telegramPaidMediaPhotoOrThrow

inline fun TelegramMedia.telegramPaidMediaPhotoOrThrow(): TelegramPaidMediaPhoto

telegramPaidMediaVideoOrNull

inline fun TelegramMedia.telegramPaidMediaVideoOrNull(): TelegramPaidMediaVideo?

telegramPaidMediaVideoOrThrow

inline fun TelegramMedia.telegramPaidMediaVideoOrThrow(): TelegramPaidMediaVideo

thumbedTelegramMediaOrNull

inline fun TelegramMedia.thumbedTelegramMediaOrNull(): ThumbedTelegramMedia?

thumbedTelegramMediaOrThrow

inline fun TelegramMedia.thumbedTelegramMediaOrThrow(): ThumbedTelegramMedia

titledTelegramMediaOrNull

inline fun TelegramMedia.titledTelegramMediaOrNull(): TitledTelegramMedia?

titledTelegramMediaOrThrow

inline fun TelegramMedia.titledTelegramMediaOrThrow(): TitledTelegramMedia

visualMediaGroupMemberTelegramMediaOrNull

inline fun TelegramMedia.visualMediaGroupMemberTelegramMediaOrNull(): VisualMediaGroupMemberTelegramMedia?

visualMediaGroupMemberTelegramMediaOrThrow

inline fun TelegramMedia.visualMediaGroupMemberTelegramMediaOrThrow(): VisualMediaGroupMemberTelegramMedia

visualTelegramPaidMediaOrNull

inline fun TelegramMedia.visualTelegramPaidMediaOrNull(): VisualTelegramPaidMedia?

visualTelegramPaidMediaOrThrow

inline fun TelegramMedia.visualTelegramPaidMediaOrThrow(): VisualTelegramPaidMedia

whenAudioMediaGroupMemberTelegramMedia

inline fun <T> TelegramFreeMedia.whenAudioMediaGroupMemberTelegramMedia(block: (AudioMediaGroupMemberTelegramMedia) -> T): T?

whenDocumentMediaGroupMemberTelegramMedia

inline fun <T> TelegramFreeMedia.whenDocumentMediaGroupMemberTelegramMedia(block: (DocumentMediaGroupMemberTelegramMedia) -> T): T?

whenDuratedTelegramMedia

inline fun <T> TelegramFreeMedia.whenDuratedTelegramMedia(block: (DuratedTelegramMedia) -> T): T?

whenMediaGroupMemberTelegramMedia

inline fun <T> TelegramFreeMedia.whenMediaGroupMemberTelegramMedia(block: (MediaGroupMemberTelegramMedia) -> T): T?

whenSizedTelegramMedia

inline fun <T> TelegramFreeMedia.whenSizedTelegramMedia(block: (SizedTelegramMedia) -> T): T?

whenTelegramMediaAnimation

inline fun <T> TelegramFreeMedia.whenTelegramMediaAnimation(block: (TelegramMediaAnimation) -> T): T?

whenTelegramMediaAudio

inline fun <T> TelegramFreeMedia.whenTelegramMediaAudio(block: (TelegramMediaAudio) -> T): T?

whenTelegramMediaDocument

inline fun <T> TelegramFreeMedia.whenTelegramMediaDocument(block: (TelegramMediaDocument) -> T): T?

whenTelegramMediaPhoto

inline fun <T> TelegramFreeMedia.whenTelegramMediaPhoto(block: (TelegramMediaPhoto) -> T): T?

whenTelegramMediaVideo

inline fun <T> TelegramFreeMedia.whenTelegramMediaVideo(block: (TelegramMediaVideo) -> T): T?

whenThumbedTelegramMedia

inline fun <T> TelegramFreeMedia.whenThumbedTelegramMedia(block: (ThumbedTelegramMedia) -> T): T?

whenTitledTelegramMedia

inline fun <T> TelegramFreeMedia.whenTitledTelegramMedia(block: (TitledTelegramMedia) -> T): T?

whenVisualMediaGroupMemberTelegramMedia

inline fun <T> TelegramFreeMedia.whenVisualMediaGroupMemberTelegramMedia(block: (VisualMediaGroupMemberTelegramMedia) -> T): T?

withCustomizableCaptionTelegramMediaOrNull

inline fun TelegramMedia.withCustomizableCaptionTelegramMediaOrNull(): WithCustomizableCaptionTelegramMedia?

withCustomizableCaptionTelegramMediaOrThrow

inline fun TelegramMedia.withCustomizableCaptionTelegramMediaOrThrow(): WithCustomizableCaptionTelegramMedia

withCustomStartTelegramMediaOrNull

inline fun TelegramMedia.withCustomStartTelegramMediaOrNull(): WithCustomStartTelegramMedia?

withCustomStartTelegramMediaOrThrow

inline fun TelegramMedia.withCustomStartTelegramMediaOrThrow(): WithCustomStartTelegramMedia