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

TelegramMediaDocument

@Serializable

data class TelegramMediaDocument : TelegramFreeMedia, DocumentMediaGroupMemberTelegramMedia, ThumbedTelegramMedia, InputPollMedia(source)

Represents a general file to be sent. See https://core.telegram.org/bots/api#inputmediadocument

Parameters

disableContentTypeDetection

Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always used by Telegram system as true, if the document is sent as part of an album.

Types

Companion

object Companion

Properties

disableContentTypeDetection

@SerialName(value = "disable_content_type_detection")

val disableContentTypeDetection: Boolean?

entities

open val entities: List<TextSource>?

file

open override val file: InputFile

media

@SerialName(value = "media")

open override val media: String

parseMode

@SerialName(value = "parse_mode")

open override val parseMode: ParseMode?

text

@SerialName(value = "caption")

open override val text: String?

textSources

open override val textSources: TextSourcesList?

Full list of TextSources

thumb

open override val thumb: InputFile?

type

@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: