tgbotapi/docs/dev.inmo.tgbotapi.types.files/index.md

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

Package dev.inmo.tgbotapi.types.files

Types

Name	Summary
AnimationFile	[common] Content data class AnimationFile(fileId: FileId, fileUniqueId: FileUniqueId, width: Int, height: Int, duration: Long?, thumb: PhotoSize?, fileName: String?, mimeType: MimeType?, fileSize: Long?) : TelegramMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, CustomNamedMediaFile, SizedMediaFile
AudioFile	[common] Content data class AudioFile(fileId: FileId, fileUniqueId: FileUniqueId, duration: Long?, performer: String?, title: String?, fileName: String?, mimeType: MimeType?, fileSize: Long?, thumb: PhotoSize?) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, TitledMediaFile, Performerable
DocumentFile	[common] Content data class DocumentFile(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long?, thumb: PhotoSize?, mimeType: MimeType?, fileName: String?) : TelegramMediaFile, MimedMediaFile, ThumbedMediaFile, CustomNamedMediaFile
File	[common] Content data class File(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long?) : TelegramMediaFile
PathedFile	[common] Content data class PathedFile(fileId: FileId, fileUniqueId: FileUniqueId, filePath: String, fileSize: Long?) : TelegramMediaFile
Photo	[common] Content typealias Photo = List<PhotoSize>
PhotoSize	[common] Content data class PhotoSize(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long?, width: Int, height: Int) : SizedMediaFile
Sticker	[common] Content data class Sticker(fileId: FileId, fileUniqueId: FileUniqueId, width: Int, height: Int, thumb: PhotoSize?, emoji: String?, stickerSetName: StickerSetName?, isAnimated: Boolean, maskPosition: MaskPosition?, fileSize: Long?) : TelegramMediaFile, SizedMediaFile, ThumbedMediaFile
VideoFile	[common] Content data class VideoFile(fileId: FileId, fileUniqueId: FileUniqueId, width: Int, height: Int, duration: Long?, thumb: PhotoSize?, fileName: String?, mimeType: MimeType?, fileSize: Long?) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, SizedMediaFile
VideoNoteFile	[common] Content data class VideoNoteFile(fileId: FileId, fileUniqueId: FileUniqueId, width: Int, duration: Long?, thumb: PhotoSize?, fileSize: Long?) : TelegramMediaFile, ThumbedMediaFile, PlayableMediaFile, SizedMediaFile
VoiceFile	[common] Content data class VoiceFile(fileId: FileId, fileUniqueId: FileUniqueId, duration: Long?, mimeType: MimeType?, fileSize: Long?) : TelegramMediaFile, MimedMediaFile, PlayableMediaFile

Functions

Name	Summary
asAudioFile	[common] Content fun VoiceFile.asAudioFile(performer: String? = null, title: String? = null, fileName: String? = null): AudioFile
asBytes	[jvm] Content fun PathedFile.asBytes(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper): ByteArray
asDocumentFile	[common] Content inline fun TelegramMediaFile.asDocumentFile(): DocumentFile
asFile	[jvm] Content fun PathedFile.asFile(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper, dest: File = File.createTempFile(this.fileUniqueId, this.filename), defaultBufferSize: Int = DEFAULT_BUFFER_SIZE): File
asStream	[jvm] Content fun PathedFile.asStream(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper): InputStream
asVoiceFile	[common] Content fun AudioFile.asVoiceFile(): VoiceFile
biggest	[common] Content fun Photo.biggest(): PhotoSize?
fullUrl	[common] Content fun PathedFile.fullUrl(keeper: TelegramAPIUrlsKeeper): String
resolveFileURL	[common] Content fun TelegramAPIUrlsKeeper.resolveFileURL(file: PathedFile): String
toInputMediaVideo	[common] Content inline fun VideoFile.toInputMediaVideo(textSources: TextSourcesList): InputMediaVideo inline fun VideoFile.toInputMediaVideo(caption: String? = null, parseMode: ParseMode? = null): InputMediaVideo

Properties

Name	Summary
filename	[common] val PathedFile.filename: FileName