docs/dev.inmo.tgbotapi.types.files/DocumentFile

DocumentFile

@Serializable

data class DocumentFile(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val fileSize: FileSize? = null, val thumbnail: PhotoSize? = null, val mimeType: MimeType? = null, val fileName: String? = null) : TelegramMediaFile, PollMedia, MimedMediaFile, ThumbedMediaFile, CustomNamedMediaFile, MediaContentVariant(source)

Constructors

DocumentFile

constructor(fileId: FileId, fileUniqueId: TgFileUniqueId, fileSize: FileSize? = null, thumbnail: PhotoSize? = null, mimeType: MimeType? = null, fileName: String? = null)

Properties

fileId

@SerialName(value = "file_id")

open override val fileId: FileId

fileName

@SerialName(value = "file_name")

open override val fileName: String?

fileSize

@SerialName(value = "file_size")

open override val fileSize: FileSize?

fileUniqueId

@SerialName(value = "file_unique_id")

open override val fileUniqueId: TgFileUniqueId

mimeType

@SerialName(value = "mime_type")

open override val mimeType: MimeType?

thumbnail

open override val thumbnail: PhotoSize?

Functions

animatedStickerOrNull

inline fun BaseTelegramMediaFile.animatedStickerOrNull(): AnimatedSticker?

animatedStickerOrThrow

inline fun BaseTelegramMediaFile.animatedStickerOrThrow(): AnimatedSticker

animationFileOrNull

inline fun BaseTelegramMediaFile.animationFileOrNull(): AnimationFile?

animationFileOrThrow

inline fun BaseTelegramMediaFile.animationFileOrThrow(): AnimationFile

asAnimatedSticker

inline fun TelegramMediaFile.asAnimatedSticker(): AnimatedSticker?

asAnimationFile

inline fun TelegramMediaFile.asAnimationFile(): AnimationFile?

asAudioFile

inline fun TelegramMediaFile.asAudioFile(): AudioFile?

asDocumentFile

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile?

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile

asFile

inline fun TelegramMediaFile.asFile(): File?

asMimedMediaFile

inline fun TelegramMediaFile.asMimedMediaFile(): MimedMediaFile?

asPathedFile

inline fun TelegramMediaFile.asPathedFile(): PathedFile?

asPhotoSize

inline fun TelegramMediaFile.asPhotoSize(): PhotoSize?

asPlayableMediaFile

inline fun TelegramMediaFile.asPlayableMediaFile(): PlayableMediaFile?

asSizedMediaFile

inline fun TelegramMediaFile.asSizedMediaFile(): SizedMediaFile?

asSticker

inline fun TelegramMediaFile.asSticker(): Sticker?

asThumbedMediaFile

inline fun TelegramMediaFile.asThumbedMediaFile(): ThumbedMediaFile?

asVideoFile

inline fun TelegramMediaFile.asVideoFile(): VideoFile?

asVideoNoteFile

inline fun TelegramMediaFile.asVideoNoteFile(): VideoNoteFile?

asVideoSticker

inline fun TelegramMediaFile.asVideoSticker(): VideoSticker?

asVoiceFile

inline fun TelegramMediaFile.asVoiceFile(): VoiceFile?

audioFileOrNull

inline fun BaseTelegramMediaFile.audioFileOrNull(): AudioFile?

audioFileOrThrow

inline fun BaseTelegramMediaFile.audioFileOrThrow(): AudioFile

coveredMediaFileOrNull

inline fun BaseTelegramMediaFile.coveredMediaFileOrNull(): CoveredMediaFile?

coveredMediaFileOrThrow

inline fun BaseTelegramMediaFile.coveredMediaFileOrThrow(): CoveredMediaFile

customEmojiAnimatedStickerOrNull

inline fun BaseTelegramMediaFile.customEmojiAnimatedStickerOrNull(): CustomEmojiAnimatedSticker?

customEmojiAnimatedStickerOrThrow

inline fun BaseTelegramMediaFile.customEmojiAnimatedStickerOrThrow(): CustomEmojiAnimatedSticker

customEmojiSimpleStickerOrNull

inline fun BaseTelegramMediaFile.customEmojiSimpleStickerOrNull(): CustomEmojiSimpleSticker?

customEmojiSimpleStickerOrThrow

inline fun BaseTelegramMediaFile.customEmojiSimpleStickerOrThrow(): CustomEmojiSimpleSticker

customEmojiStickerOrNull

inline fun BaseTelegramMediaFile.customEmojiStickerOrNull(): CustomEmojiSticker?

customEmojiStickerOrThrow

inline fun BaseTelegramMediaFile.customEmojiStickerOrThrow(): CustomEmojiSticker

customEmojiVideoStickerOrNull

inline fun BaseTelegramMediaFile.customEmojiVideoStickerOrNull(): CustomEmojiVideoSticker?

customEmojiVideoStickerOrThrow

inline fun BaseTelegramMediaFile.customEmojiVideoStickerOrThrow(): CustomEmojiVideoSticker

documentFileOrNull

inline fun BaseTelegramMediaFile.documentFileOrNull(): DocumentFile?

documentFileOrThrow

inline fun BaseTelegramMediaFile.documentFileOrThrow(): DocumentFile

fileOrNull

inline fun BaseTelegramMediaFile.fileOrNull(): File?

fileOrThrow

inline fun BaseTelegramMediaFile.fileOrThrow(): File

ifAnimatedSticker

inline fun <T> BaseTelegramMediaFile.ifAnimatedSticker(block: (AnimatedSticker) -> T): T?

ifAnimationFile

inline fun <T> BaseTelegramMediaFile.ifAnimationFile(block: (AnimationFile) -> T): T?

ifAudioFile

inline fun <T> BaseTelegramMediaFile.ifAudioFile(block: (AudioFile) -> T): T?

ifCoveredMediaFile

inline fun <T> BaseTelegramMediaFile.ifCoveredMediaFile(block: (CoveredMediaFile) -> T): T?

ifCustomEmojiAnimatedSticker

inline fun <T> BaseTelegramMediaFile.ifCustomEmojiAnimatedSticker(block: (CustomEmojiAnimatedSticker) -> T): T?

ifCustomEmojiSimpleSticker

inline fun <T> BaseTelegramMediaFile.ifCustomEmojiSimpleSticker(block: (CustomEmojiSimpleSticker) -> T): T?

ifCustomEmojiSticker

inline fun <T> BaseTelegramMediaFile.ifCustomEmojiSticker(block: (CustomEmojiSticker) -> T): T?

ifCustomEmojiVideoSticker

inline fun <T> BaseTelegramMediaFile.ifCustomEmojiVideoSticker(block: (CustomEmojiVideoSticker) -> T): T?

ifDocumentFile

inline fun <T> BaseTelegramMediaFile.ifDocumentFile(block: (DocumentFile) -> T): T?

ifFile

inline fun <T> BaseTelegramMediaFile.ifFile(block: (File) -> T): T?

ifLink

inline fun <T> BaseTelegramMediaFile.ifLink(block: (Link) -> T): T?

ifLivePhotoFile

inline fun <T> BaseTelegramMediaFile.ifLivePhotoFile(block: (LivePhotoFile) -> T): T?

ifMaskAnimatedSticker

inline fun <T> BaseTelegramMediaFile.ifMaskAnimatedSticker(block: (MaskAnimatedSticker) -> T): T?

ifMaskSimpleSticker

inline fun <T> BaseTelegramMediaFile.ifMaskSimpleSticker(block: (MaskSimpleSticker) -> T): T?

ifMaskSticker

inline fun <T> BaseTelegramMediaFile.ifMaskSticker(block: (MaskSticker) -> T): T?

ifMaskVideoSticker

inline fun <T> BaseTelegramMediaFile.ifMaskVideoSticker(block: (MaskVideoSticker) -> T): T?

ifMediaContentVariant

inline fun <T> BaseTelegramMediaFile.ifMediaContentVariant(block: (MediaContentVariant) -> T): T?

ifMimedMediaFile

inline fun <T> BaseTelegramMediaFile.ifMimedMediaFile(block: (MimedMediaFile) -> T): T?

ifPassportFile

inline fun <T> BaseTelegramMediaFile.ifPassportFile(block: (PassportFile) -> T): T?

ifPathedFile

inline fun <T> BaseTelegramMediaFile.ifPathedFile(block: (PathedFile) -> T): T?

ifPhotoFile

inline fun <T> BaseTelegramMediaFile.ifPhotoFile(block: (PhotoFile) -> T): T?

ifPhotoSize

inline fun <T> BaseTelegramMediaFile.ifPhotoSize(block: (PhotoSize) -> T): T?

ifPlayableMediaFile

inline fun <T> BaseTelegramMediaFile.ifPlayableMediaFile(block: (PlayableMediaFile) -> T): T?

ifPollMedia

inline fun <T> BaseTelegramMediaFile.ifPollMedia(block: (PollMedia) -> T): T?

ifRegularAnimatedSticker

inline fun <T> BaseTelegramMediaFile.ifRegularAnimatedSticker(block: (RegularAnimatedSticker) -> T): T?

ifRegularSimpleSticker

inline fun <T> BaseTelegramMediaFile.ifRegularSimpleSticker(block: (RegularSimpleSticker) -> T): T?

ifRegularSticker

inline fun <T> BaseTelegramMediaFile.ifRegularSticker(block: (RegularSticker) -> T): T?

ifRegularVideoSticker

inline fun <T> BaseTelegramMediaFile.ifRegularVideoSticker(block: (RegularVideoSticker) -> T): T?

ifSizedMediaFile

inline fun <T> BaseTelegramMediaFile.ifSizedMediaFile(block: (SizedMediaFile) -> T): T?

ifStaticLocation

inline fun <T> BaseTelegramMediaFile.ifStaticLocation(block: (StaticLocation) -> T): T?

ifSticker

inline fun <T> BaseTelegramMediaFile.ifSticker(block: (Sticker) -> T): T?

ifTelegramMediaFile

inline fun <T> BaseTelegramMediaFile.ifTelegramMediaFile(block: (TelegramMediaFile) -> T): T?

ifThumbedMediaFile

inline fun <T> BaseTelegramMediaFile.ifThumbedMediaFile(block: (ThumbedMediaFile) -> T): T?

ifUnknownSticker

inline fun <T> BaseTelegramMediaFile.ifUnknownSticker(block: (UnknownSticker) -> T): T?

ifUsefulAsPaidMediaFile

inline fun <T> BaseTelegramMediaFile.ifUsefulAsPaidMediaFile(block: (UsefulAsPaidMediaFile) -> T): T?

ifVenue

inline fun <T> BaseTelegramMediaFile.ifVenue(block: (Venue) -> T): T?

ifVideoFile

inline fun <T> BaseTelegramMediaFile.ifVideoFile(block: (VideoFile) -> T): T?

ifVideoNoteFile

inline fun <T> BaseTelegramMediaFile.ifVideoNoteFile(block: (VideoNoteFile) -> T): T?

ifVideoQuality

inline fun <T> BaseTelegramMediaFile.ifVideoQuality(block: (VideoQuality) -> T): T?

ifVideoSticker

inline fun <T> BaseTelegramMediaFile.ifVideoSticker(block: (VideoSticker) -> T): T?

ifVoiceFile

inline fun <T> BaseTelegramMediaFile.ifVoiceFile(block: (VoiceFile) -> T): T?

linkOrNull

inline fun BaseTelegramMediaFile.linkOrNull(): Link?

linkOrThrow

inline fun BaseTelegramMediaFile.linkOrThrow(): Link

livePhotoFileOrNull

inline fun BaseTelegramMediaFile.livePhotoFileOrNull(): LivePhotoFile?

livePhotoFileOrThrow

inline fun BaseTelegramMediaFile.livePhotoFileOrThrow(): LivePhotoFile

maskAnimatedStickerOrNull

inline fun BaseTelegramMediaFile.maskAnimatedStickerOrNull(): MaskAnimatedSticker?

maskAnimatedStickerOrThrow

inline fun BaseTelegramMediaFile.maskAnimatedStickerOrThrow(): MaskAnimatedSticker

maskSimpleStickerOrNull

inline fun BaseTelegramMediaFile.maskSimpleStickerOrNull(): MaskSimpleSticker?

maskSimpleStickerOrThrow

inline fun BaseTelegramMediaFile.maskSimpleStickerOrThrow(): MaskSimpleSticker

maskStickerOrNull

inline fun BaseTelegramMediaFile.maskStickerOrNull(): MaskSticker?

maskStickerOrThrow

inline fun BaseTelegramMediaFile.maskStickerOrThrow(): MaskSticker

maskVideoStickerOrNull

inline fun BaseTelegramMediaFile.maskVideoStickerOrNull(): MaskVideoSticker?

maskVideoStickerOrThrow

inline fun BaseTelegramMediaFile.maskVideoStickerOrThrow(): MaskVideoSticker

mediaContentVariantOrNull

inline fun BaseTelegramMediaFile.mediaContentVariantOrNull(): MediaContentVariant?

mediaContentVariantOrThrow

inline fun BaseTelegramMediaFile.mediaContentVariantOrThrow(): MediaContentVariant

mimedMediaFileOrNull

inline fun BaseTelegramMediaFile.mimedMediaFileOrNull(): MimedMediaFile?

mimedMediaFileOrThrow

inline fun BaseTelegramMediaFile.mimedMediaFileOrThrow(): MimedMediaFile

passportFileOrNull

inline fun BaseTelegramMediaFile.passportFileOrNull(): PassportFile?

passportFileOrThrow

inline fun BaseTelegramMediaFile.passportFileOrThrow(): PassportFile

pathedFileOrNull

inline fun BaseTelegramMediaFile.pathedFileOrNull(): PathedFile?

pathedFileOrThrow

inline fun BaseTelegramMediaFile.pathedFileOrThrow(): PathedFile

photoFileOrNull

inline fun BaseTelegramMediaFile.photoFileOrNull(): PhotoFile?

photoFileOrThrow

inline fun BaseTelegramMediaFile.photoFileOrThrow(): PhotoFile

photoSizeOrNull

inline fun BaseTelegramMediaFile.photoSizeOrNull(): PhotoSize?

photoSizeOrThrow

inline fun BaseTelegramMediaFile.photoSizeOrThrow(): PhotoSize

playableMediaFileOrNull

inline fun BaseTelegramMediaFile.playableMediaFileOrNull(): PlayableMediaFile?

playableMediaFileOrThrow

inline fun BaseTelegramMediaFile.playableMediaFileOrThrow(): PlayableMediaFile

pollMediaOrNull

inline fun BaseTelegramMediaFile.pollMediaOrNull(): PollMedia?

pollMediaOrThrow

inline fun BaseTelegramMediaFile.pollMediaOrThrow(): PollMedia

regularAnimatedStickerOrNull

inline fun BaseTelegramMediaFile.regularAnimatedStickerOrNull(): RegularAnimatedSticker?

regularAnimatedStickerOrThrow

inline fun BaseTelegramMediaFile.regularAnimatedStickerOrThrow(): RegularAnimatedSticker

regularSimpleStickerOrNull

inline fun BaseTelegramMediaFile.regularSimpleStickerOrNull(): RegularSimpleSticker?

regularSimpleStickerOrThrow

inline fun BaseTelegramMediaFile.regularSimpleStickerOrThrow(): RegularSimpleSticker

regularStickerOrNull

inline fun BaseTelegramMediaFile.regularStickerOrNull(): RegularSticker?

regularStickerOrThrow

inline fun BaseTelegramMediaFile.regularStickerOrThrow(): RegularSticker

regularVideoStickerOrNull

inline fun BaseTelegramMediaFile.regularVideoStickerOrNull(): RegularVideoSticker?

regularVideoStickerOrThrow

inline fun BaseTelegramMediaFile.regularVideoStickerOrThrow(): RegularVideoSticker

requireAnimatedSticker

inline fun TelegramMediaFile.requireAnimatedSticker(): AnimatedSticker

requireAnimationFile

inline fun TelegramMediaFile.requireAnimationFile(): AnimationFile

requireAudioFile

inline fun TelegramMediaFile.requireAudioFile(): AudioFile

requireDocumentFile

inline fun TelegramMediaFile.requireDocumentFile(): DocumentFile

requireFile

inline fun TelegramMediaFile.requireFile(): File

requireMimedMediaFile

inline fun TelegramMediaFile.requireMimedMediaFile(): MimedMediaFile

requirePathedFile

inline fun TelegramMediaFile.requirePathedFile(): PathedFile

requirePhotoSize

inline fun TelegramMediaFile.requirePhotoSize(): PhotoSize

requirePlayableMediaFile

inline fun TelegramMediaFile.requirePlayableMediaFile(): PlayableMediaFile

requireSizedMediaFile

inline fun TelegramMediaFile.requireSizedMediaFile(): SizedMediaFile

requireSticker

inline fun TelegramMediaFile.requireSticker(): Sticker

requireThumbedMediaFile

inline fun TelegramMediaFile.requireThumbedMediaFile(): ThumbedMediaFile

requireVideoFile

inline fun TelegramMediaFile.requireVideoFile(): VideoFile

requireVideoNoteFile

inline fun TelegramMediaFile.requireVideoNoteFile(): VideoNoteFile

requireVideoSticker

inline fun TelegramMediaFile.requireVideoSticker(): VideoSticker

requireVoiceFile

inline fun TelegramMediaFile.requireVoiceFile(): VoiceFile

sizedMediaFileOrNull

inline fun BaseTelegramMediaFile.sizedMediaFileOrNull(): SizedMediaFile?

sizedMediaFileOrThrow

inline fun BaseTelegramMediaFile.sizedMediaFileOrThrow(): SizedMediaFile

staticLocationOrNull

inline fun BaseTelegramMediaFile.staticLocationOrNull(): StaticLocation?

staticLocationOrThrow

inline fun BaseTelegramMediaFile.staticLocationOrThrow(): StaticLocation

stickerOrNull

inline fun BaseTelegramMediaFile.stickerOrNull(): Sticker?

stickerOrThrow

inline fun BaseTelegramMediaFile.stickerOrThrow(): Sticker

telegramMediaFileOrNull

inline fun BaseTelegramMediaFile.telegramMediaFileOrNull(): TelegramMediaFile?

telegramMediaFileOrThrow

inline fun BaseTelegramMediaFile.telegramMediaFileOrThrow(): TelegramMediaFile

thumbedMediaFileOrNull

inline fun BaseTelegramMediaFile.thumbedMediaFileOrNull(): ThumbedMediaFile?

thumbedMediaFileOrThrow

inline fun BaseTelegramMediaFile.thumbedMediaFileOrThrow(): ThumbedMediaFile

toTelegramMediaDocument

fun DocumentFile.toTelegramMediaDocument(textSources: TextSourcesList = emptyList()): TelegramMediaDocument

fun DocumentFile.toTelegramMediaDocument(text: String? = null, parseMode: ParseMode? = null): TelegramMediaDocument

unknownStickerOrNull

inline fun BaseTelegramMediaFile.unknownStickerOrNull(): UnknownSticker?

unknownStickerOrThrow

inline fun BaseTelegramMediaFile.unknownStickerOrThrow(): UnknownSticker

usefulAsPaidMediaFileOrNull

inline fun BaseTelegramMediaFile.usefulAsPaidMediaFileOrNull(): UsefulAsPaidMediaFile?

usefulAsPaidMediaFileOrThrow

inline fun BaseTelegramMediaFile.usefulAsPaidMediaFileOrThrow(): UsefulAsPaidMediaFile

venueOrNull

inline fun BaseTelegramMediaFile.venueOrNull(): Venue?

venueOrThrow

inline fun BaseTelegramMediaFile.venueOrThrow(): Venue

videoFileOrNull

inline fun BaseTelegramMediaFile.videoFileOrNull(): VideoFile?

videoFileOrThrow

inline fun BaseTelegramMediaFile.videoFileOrThrow(): VideoFile

videoNoteFileOrNull

inline fun BaseTelegramMediaFile.videoNoteFileOrNull(): VideoNoteFile?

videoNoteFileOrThrow

inline fun BaseTelegramMediaFile.videoNoteFileOrThrow(): VideoNoteFile

videoQualityOrNull

inline fun BaseTelegramMediaFile.videoQualityOrNull(): VideoQuality?

videoQualityOrThrow

inline fun BaseTelegramMediaFile.videoQualityOrThrow(): VideoQuality

videoStickerOrNull

inline fun BaseTelegramMediaFile.videoStickerOrNull(): VideoSticker?

videoStickerOrThrow

inline fun BaseTelegramMediaFile.videoStickerOrThrow(): VideoSticker

voiceFileOrNull

inline fun BaseTelegramMediaFile.voiceFileOrNull(): VoiceFile?

voiceFileOrThrow

inline fun BaseTelegramMediaFile.voiceFileOrThrow(): VoiceFile

whenAnimatedSticker

inline fun <T> TelegramMediaFile.whenAnimatedSticker(block: (AnimatedSticker) -> T): T?

whenAnimationFile

inline fun <T> TelegramMediaFile.whenAnimationFile(block: (AnimationFile) -> T): T?

whenAudioFile

inline fun <T> TelegramMediaFile.whenAudioFile(block: (AudioFile) -> T): T?

whenDocumentFile

inline fun <T> TelegramMediaFile.whenDocumentFile(block: (DocumentFile) -> T): T?

whenFile

inline fun <T> TelegramMediaFile.whenFile(block: (File) -> T): T?

whenMimedMediaFile

inline fun <T> TelegramMediaFile.whenMimedMediaFile(block: (MimedMediaFile) -> T): T?

whenPathedFile

inline fun <T> TelegramMediaFile.whenPathedFile(block: (PathedFile) -> T): T?

whenPhotoSize

inline fun <T> TelegramMediaFile.whenPhotoSize(block: (PhotoSize) -> T): T?

whenPlayableMediaFile

inline fun <T> TelegramMediaFile.whenPlayableMediaFile(block: (PlayableMediaFile) -> T): T?

whenSizedMediaFile

inline fun <T> TelegramMediaFile.whenSizedMediaFile(block: (SizedMediaFile) -> T): T?

whenSticker

inline fun <T> TelegramMediaFile.whenSticker(block: (Sticker) -> T): T?

whenThumbedMediaFile

inline fun <T> TelegramMediaFile.whenThumbedMediaFile(block: (ThumbedMediaFile) -> T): T?

whenVideoFile

inline fun <T> TelegramMediaFile.whenVideoFile(block: (VideoFile) -> T): T?

whenVideoNoteFile

inline fun <T> TelegramMediaFile.whenVideoNoteFile(block: (VideoNoteFile) -> T): T?

whenVideoSticker

inline fun <T> TelegramMediaFile.whenVideoSticker(block: (VideoSticker) -> T): T?

whenVoiceFile

inline fun <T> TelegramMediaFile.whenVoiceFile(block: (VoiceFile) -> T): T?