docs/dev.inmo.tgbotapi.types.files

Package-level declarations

Types

@Serializable

data class AnimationFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val duration: Long? = null, val thumb: PhotoSize? = null, val fileName: String? = null, val mimeType: MimeType? = null, val fileSize: Long? = null) : TelegramMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, CustomNamedMediaFile, SizedMediaFile

AudioFile

@Serializable

data class AudioFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val duration: Long? = null, val performer: String? = null, val title: String? = null, val fileName: String? = null, val mimeType: MimeType? = null, val fileSize: Long? = null, val thumb: PhotoSize? = null) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, TitledMediaFile, Performerable

CustomEmojiAnimatedSticker

@Serializable

data class CustomEmojiAnimatedSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val customEmojiId: CustomEmojiId, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : CustomEmojiSticker, AnimatedSticker

CustomEmojiSimpleSticker

@Serializable

data class CustomEmojiSimpleSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val customEmojiId: CustomEmojiId, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : CustomEmojiSticker

CustomEmojiSticker

@Serializable

interface CustomEmojiSticker : Sticker

CustomEmojiVideoSticker

@Serializable

data class CustomEmojiVideoSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val customEmojiId: CustomEmojiId, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : CustomEmojiSticker, VideoSticker

CustomNamedMediaFile

interface CustomNamedMediaFile

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

File

@Serializable

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

MaskAnimatedSticker

@Serializable

data class MaskAnimatedSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val maskPosition: MaskPosition, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : MaskSticker, AnimatedSticker

MaskSimpleSticker

@Serializable

data class MaskSimpleSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val maskPosition: MaskPosition, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : MaskSticker

MaskSticker

@Serializable

interface MaskSticker : Sticker

MaskVideoSticker

@Serializable

data class MaskVideoSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val maskPosition: MaskPosition, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : MaskSticker, VideoSticker

MimedMediaFile

interface MimedMediaFile : TelegramMediaFile, MimeTyped

PassportFile

@Serializable

data class PassportFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val uploadingDate: TelegramDate, val fileSize: Long? = null) : TelegramMediaFile

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

PathedFile

@Serializable

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

Photo

typealias Photo = List<PhotoSize>

PhotoSerializer

object PhotoSerializer : KSerializer<Photo>

PhotoSize

@Serializable

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

PlayableMediaFile

interface PlayableMediaFile : TelegramMediaFile

RegularAnimatedSticker

@Serializable

data class RegularAnimatedSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val premiumAnimationFile: File?, val fileSize: Long? = null) : RegularSticker, AnimatedSticker

RegularSimpleSticker

@Serializable

data class RegularSimpleSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val premiumAnimationFile: File?, val fileSize: Long? = null) : RegularSticker

RegularSticker

@Serializable

interface RegularSticker : Sticker

RegularVideoSticker

@Serializable

data class RegularVideoSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val premiumAnimationFile: File?, val fileSize: Long? = null) : RegularSticker, VideoSticker

SizedMediaFile

interface SizedMediaFile : TelegramMediaFile

Sticker

@Serializable(with = StickerSerializer::class)

interface Sticker : TelegramMediaFile, SizedMediaFile, ThumbedMediaFile

StickerSerializer

object StickerSerializer : KSerializer<Sticker>

StickerSurrogate

@Serializable

data class StickerSurrogate(val file_id: FileId, val file_unique_id: FileUniqueId, val type: StickerType, val width: Int, val height: Int, val is_animated: Boolean? = null, val is_video: Boolean? = null, val thumb: PhotoSize? = null, val emoji: String? = null, val set_name: StickerSetName? = null, val premium_animation: File? = null, val mask_position: MaskPosition? = null, val custom_emoji_id: CustomEmojiId? = null, val file_size: Long? = null)

TelegramMediaFile

interface TelegramMediaFile

Declare common part of media files in Telegram. Note: it is not representation of JVM File type

ThumbedMediaFile

interface ThumbedMediaFile : TelegramMediaFile

TitledMediaFile

interface TitledMediaFile

UnknownSticker

@Serializable

data class UnknownSticker(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val thumb: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null, val raw: JsonElement) : Sticker

VideoFile

@Serializable

data class VideoFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val width: Int, val height: Int, val duration: Long? = null, val thumb: PhotoSize? = null, val fileName: String? = null, val mimeType: MimeType? = null, val fileSize: Long? = null) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, SizedMediaFile

VideoNoteFile

@Serializable

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

VideoSticker

@Serializable

interface VideoSticker : Sticker

VoiceFile

@Serializable

data class VoiceFile(val fileId: FileId, val fileUniqueId: FileUniqueId, val duration: Long? = null, val mimeType: MimeType? = null, val fileSize: Long? = null) : 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

toTelegramMediaVideo

inline fun VideoFile.toTelegramMediaVideo(textSources: TextSourcesList, spoilered: Boolean = false): TelegramMediaVideo

inline fun VideoFile.toTelegramMediaVideo(text: String? = null, parseMode: ParseMode? = null, spoilered: Boolean = false): TelegramMediaVideo