Package dev.inmo.tgbotapi.types.files

Types

AnimationFile

common

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

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

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

File

common

data class File(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long?) : TelegramMediaFile

PathedFile

common

data class PathedFile(fileId: FileId, fileUniqueId: FileUniqueId, filePath: String, fileSize: Long?) : TelegramMediaFile

Photo

common

typealias Photo = List<PhotoSize>

PhotoSerializer

common

object PhotoSerializer : KSerializer<Photo>

PhotoSize

common

data class PhotoSize(fileId: FileId, fileUniqueId: FileUniqueId, fileSize: Long?, width: Int, height: Int) : SizedMediaFile

Sticker

common

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

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

data class VideoNoteFile(fileId: FileId, fileUniqueId: FileUniqueId, width: Int, duration: Long?, thumb: PhotoSize?, fileSize: Long?) : TelegramMediaFile, ThumbedMediaFile, PlayableMediaFile, SizedMediaFile

VoiceFile

common

data class VoiceFile(fileId: FileId, fileUniqueId: FileUniqueId, duration: Long?, mimeType: MimeType?, fileSize: Long?) : TelegramMediaFile, MimedMediaFile, PlayableMediaFile

Functions

asAudioFile

common

fun VoiceFile.asAudioFile(performer: String? = null, title: String? = null, fileName: String? = null): AudioFile

asBytes

jvm

fun PathedFile.asBytes(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper): ByteArray

asDocumentFile

common

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile

asFile

jvm

fun PathedFile.asFile(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper, dest: File = File.createTempFile(this.fileUniqueId, this.filename), defaultBufferSize: Int = DEFAULT_BUFFER_SIZE): File

asStream

jvm

fun PathedFile.asStream(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper): InputStream

asVoiceFile

common

fun AudioFile.asVoiceFile(): VoiceFile

biggest

common

fun Photo.biggest(): PhotoSize?

fullUrl

common

fun PathedFile.fullUrl(keeper: TelegramAPIUrlsKeeper): String

resolveFileURL

common

fun TelegramAPIUrlsKeeper.resolveFileURL(file: PathedFile): String

toInputMediaVideo

common

inline fun VideoFile.toInputMediaVideo(textSources: TextSourcesList): InputMediaVideo

inline fun VideoFile.toInputMediaVideo(text: String? = null, parseMode: ParseMode? = null): InputMediaVideo

Properties

filename

common

val PathedFile.filename: FileName