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

DocumentFile

@Serializable

data class DocumentFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val fileSize: Long? = null, val thumb: PhotoSize? = null, val mimeType: MimeType? = null, val fileName: String? = null) : TelegramMediaFile, MimedMediaFile, ThumbedMediaFile, CustomNamedMediaFile

Constructors

constructor(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long? = null, thumb: PhotoSize? = null, mimeType: MimeType? = null, fileName: String? = null)

Functions

animatedStickerOrNull

inline fun TelegramMediaFile.animatedStickerOrNull(): AnimatedSticker?

animatedStickerOrThrow

inline fun TelegramMediaFile.animatedStickerOrThrow(): AnimatedSticker

animationFileOrNull

inline fun TelegramMediaFile.animationFileOrNull(): AnimationFile?

animationFileOrThrow

inline fun TelegramMediaFile.animationFileOrThrow(): AnimationFile

asAnimatedSticker

inline fun TelegramMediaFile.asAnimatedSticker(): AnimatedSticker?

asAnimationFile

inline fun TelegramMediaFile.asAnimationFile(): AnimationFile?

inline fun TelegramMediaFile.asAudioFile(): AudioFile?

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile?

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile

inline fun TelegramMediaFile.asFile(): File?

asMimedMediaFile

inline fun TelegramMediaFile.asMimedMediaFile(): MimedMediaFile?

inline fun TelegramMediaFile.asPathedFile(): PathedFile?

inline fun TelegramMediaFile.asPhotoSize(): PhotoSize?

asPlayableMediaFile

inline fun TelegramMediaFile.asPlayableMediaFile(): PlayableMediaFile?

asSimpleSticker

inline fun TelegramMediaFile.asSimpleSticker(): SimpleSticker?

asSizedMediaFile

inline fun TelegramMediaFile.asSizedMediaFile(): SizedMediaFile?

inline fun TelegramMediaFile.asSticker(): Sticker?

asThumbedMediaFile

inline fun TelegramMediaFile.asThumbedMediaFile(): ThumbedMediaFile?

inline fun TelegramMediaFile.asVideoFile(): VideoFile?

asVideoNoteFile

inline fun TelegramMediaFile.asVideoNoteFile(): VideoNoteFile?

inline fun TelegramMediaFile.asVideoSticker(): VideoSticker?

inline fun TelegramMediaFile.asVoiceFile(): VoiceFile?

audioFileOrNull

inline fun TelegramMediaFile.audioFileOrNull(): AudioFile?

audioFileOrThrow

inline fun TelegramMediaFile.audioFileOrThrow(): AudioFile

customEmojiAnimatedStickerOrNull

inline fun TelegramMediaFile.customEmojiAnimatedStickerOrNull(): CustomEmojiAnimatedSticker?

customEmojiAnimatedStickerOrThrow

inline fun TelegramMediaFile.customEmojiAnimatedStickerOrThrow(): CustomEmojiAnimatedSticker

customEmojiSimpleStickerOrNull

inline fun TelegramMediaFile.customEmojiSimpleStickerOrNull(): CustomEmojiSimpleSticker?

customEmojiSimpleStickerOrThrow

inline fun TelegramMediaFile.customEmojiSimpleStickerOrThrow(): CustomEmojiSimpleSticker

customEmojiStickerOrNull

inline fun TelegramMediaFile.customEmojiStickerOrNull(): CustomEmojiSticker?

customEmojiStickerOrThrow

inline fun TelegramMediaFile.customEmojiStickerOrThrow(): CustomEmojiSticker

customEmojiVideoStickerOrNull

inline fun TelegramMediaFile.customEmojiVideoStickerOrNull(): CustomEmojiVideoSticker?

customEmojiVideoStickerOrThrow

inline fun TelegramMediaFile.customEmojiVideoStickerOrThrow(): CustomEmojiVideoSticker

documentFileOrNull

inline fun TelegramMediaFile.documentFileOrNull(): DocumentFile?

documentFileOrThrow

inline fun TelegramMediaFile.documentFileOrThrow(): DocumentFile

inline fun TelegramMediaFile.fileOrNull(): File?

inline fun TelegramMediaFile.fileOrThrow(): File

ifAnimatedSticker

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

ifAnimationFile

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

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

ifCustomEmojiAnimatedSticker

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

ifCustomEmojiSimpleSticker

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

ifCustomEmojiSticker

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

ifCustomEmojiVideoSticker

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

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

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

ifMaskAnimatedSticker

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

ifMaskSimpleSticker

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

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

ifMaskVideoSticker

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

ifMimedMediaFile

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

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

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

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

ifPlayableMediaFile

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

ifRegularAnimatedSticker

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

ifRegularSimpleSticker

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

ifRegularSticker

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

ifRegularVideoSticker

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

ifSizedMediaFile

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

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

ifThumbedMediaFile

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

ifUnknownSticker

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

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

ifVideoNoteFile

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

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

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

maskAnimatedStickerOrNull

inline fun TelegramMediaFile.maskAnimatedStickerOrNull(): MaskAnimatedSticker?

maskAnimatedStickerOrThrow

inline fun TelegramMediaFile.maskAnimatedStickerOrThrow(): MaskAnimatedSticker

maskSimpleStickerOrNull

inline fun TelegramMediaFile.maskSimpleStickerOrNull(): MaskSimpleSticker?

maskSimpleStickerOrThrow

inline fun TelegramMediaFile.maskSimpleStickerOrThrow(): MaskSimpleSticker

maskStickerOrNull

inline fun TelegramMediaFile.maskStickerOrNull(): MaskSticker?

maskStickerOrThrow

inline fun TelegramMediaFile.maskStickerOrThrow(): MaskSticker

maskVideoStickerOrNull

inline fun TelegramMediaFile.maskVideoStickerOrNull(): MaskVideoSticker?

maskVideoStickerOrThrow

inline fun TelegramMediaFile.maskVideoStickerOrThrow(): MaskVideoSticker

mimedMediaFileOrNull

inline fun TelegramMediaFile.mimedMediaFileOrNull(): MimedMediaFile?

mimedMediaFileOrThrow

inline fun TelegramMediaFile.mimedMediaFileOrThrow(): MimedMediaFile

passportFileOrNull

inline fun TelegramMediaFile.passportFileOrNull(): PassportFile?

passportFileOrThrow

inline fun TelegramMediaFile.passportFileOrThrow(): PassportFile

pathedFileOrNull

inline fun TelegramMediaFile.pathedFileOrNull(): PathedFile?

pathedFileOrThrow

inline fun TelegramMediaFile.pathedFileOrThrow(): PathedFile

photoSizeOrNull

inline fun TelegramMediaFile.photoSizeOrNull(): PhotoSize?

photoSizeOrThrow

inline fun TelegramMediaFile.photoSizeOrThrow(): PhotoSize

playableMediaFileOrNull

inline fun TelegramMediaFile.playableMediaFileOrNull(): PlayableMediaFile?

playableMediaFileOrThrow

inline fun TelegramMediaFile.playableMediaFileOrThrow(): PlayableMediaFile

regularAnimatedStickerOrNull

inline fun TelegramMediaFile.regularAnimatedStickerOrNull(): RegularAnimatedSticker?

regularAnimatedStickerOrThrow

inline fun TelegramMediaFile.regularAnimatedStickerOrThrow(): RegularAnimatedSticker

regularSimpleStickerOrNull

inline fun TelegramMediaFile.regularSimpleStickerOrNull(): RegularSimpleSticker?

regularSimpleStickerOrThrow

inline fun TelegramMediaFile.regularSimpleStickerOrThrow(): RegularSimpleSticker

regularStickerOrNull

inline fun TelegramMediaFile.regularStickerOrNull(): RegularSticker?

regularStickerOrThrow

inline fun TelegramMediaFile.regularStickerOrThrow(): RegularSticker

regularVideoStickerOrNull

inline fun TelegramMediaFile.regularVideoStickerOrNull(): RegularVideoSticker?

regularVideoStickerOrThrow

inline fun TelegramMediaFile.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

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

requireSimpleSticker

inline fun TelegramMediaFile.requireSimpleSticker(): SimpleSticker

requireSizedMediaFile

inline fun TelegramMediaFile.requireSizedMediaFile(): SizedMediaFile

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 TelegramMediaFile.sizedMediaFileOrNull(): SizedMediaFile?

sizedMediaFileOrThrow

inline fun TelegramMediaFile.sizedMediaFileOrThrow(): SizedMediaFile

inline fun TelegramMediaFile.stickerOrNull(): Sticker?

inline fun TelegramMediaFile.stickerOrThrow(): Sticker

thumbedMediaFileOrNull

inline fun TelegramMediaFile.thumbedMediaFileOrNull(): ThumbedMediaFile?

thumbedMediaFileOrThrow

inline fun TelegramMediaFile.thumbedMediaFileOrThrow(): ThumbedMediaFile

toTelegramMediaDocument

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

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

unknownStickerOrNull

inline fun TelegramMediaFile.unknownStickerOrNull(): UnknownSticker?

unknownStickerOrThrow

inline fun TelegramMediaFile.unknownStickerOrThrow(): UnknownSticker

videoFileOrNull

inline fun TelegramMediaFile.videoFileOrNull(): VideoFile?

videoFileOrThrow

inline fun TelegramMediaFile.videoFileOrThrow(): VideoFile

videoNoteFileOrNull

inline fun TelegramMediaFile.videoNoteFileOrNull(): VideoNoteFile?

videoNoteFileOrThrow

inline fun TelegramMediaFile.videoNoteFileOrThrow(): VideoNoteFile

videoStickerOrNull

inline fun TelegramMediaFile.videoStickerOrNull(): VideoSticker?

videoStickerOrThrow

inline fun TelegramMediaFile.videoStickerOrThrow(): VideoSticker

voiceFileOrNull

inline fun TelegramMediaFile.voiceFileOrNull(): VoiceFile?

voiceFileOrThrow

inline fun TelegramMediaFile.voiceFileOrThrow(): VoiceFile

whenAnimatedSticker

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

whenAnimationFile

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

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

whenDocumentFile

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

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

whenMimedMediaFile

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

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

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

whenPlayableMediaFile

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

whenSimpleSticker

inline fun <T> TelegramMediaFile.whenSimpleSticker(block: (SimpleSticker) -> T): T?

whenSizedMediaFile

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

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

whenThumbedMediaFile

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

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?

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

Properties

open override val fileId: FileId

open override val fileName: String? = null

open override val fileSize: Long? = null

open override val fileUniqueId: FileUniqueId

open override val mimeType: MimeType? = null

open override val thumb: PhotoSize? = null