docs/dev.inmo.tgbotapi.types.files

Package dev.inmo.tgbotapi.types.files

Types

AnimationFile

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

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

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

File

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

PathedFile

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

Photo

typealias Photo = List<PhotoSize>

PhotoSerializer

object PhotoSerializer : KSerializer<Photo>

PhotoSize

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

Sticker

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

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

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

VoiceFile

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

Functions

asAudioFile

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

asDocumentFile

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile

asStream

fun PathedFile.asStream(telegramAPIUrlsKeeper: TelegramAPIUrlsKeeper): InputStream

asVoiceFile

fun AudioFile.asVoiceFile(): VoiceFile

biggest

fun Photo.biggest(): PhotoSize?

fullUrl

fun PathedFile.fullUrl(keeper: TelegramAPIUrlsKeeper): String

resolveFileURL

fun TelegramAPIUrlsKeeper.resolveFileURL(file: PathedFile): String

toInputMediaVideo

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

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