tgbotapi.core/dev.inmo.tgbotapi.types.files

Package-level declarations

Types

@Serializable

sealed interface AnimatedSticker : Sticker

@Serializable

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

AudioFile

@Serializable

data class AudioFile(val fileId: FileId, val fileUniqueId: TgFileUniqueId, 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 thumbnail: PhotoSize? = null) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, ThumbedMediaFile, PlayableMediaFile, TitledMediaFile, Performerable, MediaContentVariant

CoveredMediaFile

sealed interface CoveredMediaFile : TelegramMediaFile, CoverableData

CustomEmojiAnimatedSticker

@Serializable

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

CustomEmojiSimpleSticker

@Serializable

data class CustomEmojiSimpleSticker(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val width: Int, val height: Int, val customEmojiId: CustomEmojiId, val thumbnail: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null, val needsRepainting: Boolean = false) : CustomEmojiSticker

CustomEmojiSticker

@Serializable

sealed interface CustomEmojiSticker : Sticker

CustomEmojiVideoSticker

@Serializable

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

CustomNamedMediaFile

sealed interface CustomNamedMediaFile

CustomStartMediaFile

sealed interface CustomStartMediaFile : WithCustomStartMediaData

DocumentFile

@Serializable

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

File

@Serializable

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

MaskAnimatedSticker

@Serializable

data class MaskAnimatedSticker(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val width: Int, val height: Int, val maskPosition: MaskPosition? = null, val thumbnail: 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: TgFileUniqueId, val width: Int, val height: Int, val maskPosition: MaskPosition? = null, val thumbnail: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null) : MaskSticker

MaskSticker

@Serializable

sealed interface MaskSticker : Sticker

MaskVideoSticker

@Serializable

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

MediaContentVariant

interface MediaContentVariant : ReplyInfo.External.ContentVariant, TelegramMediaFile

MimedMediaFile

sealed interface MimedMediaFile : TelegramMediaFile, MimeTyped

PaidMediaInfo

@Serializable

data class PaidMediaInfo(val stars: Int, val media: List<PaidMedia>) : ReplyInfo.External.ContentVariant

PassportFile

@Serializable

data class PassportFile(val fileId: FileId, val fileUniqueId: TgFileUniqueId, 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: TgFileUniqueId, val filePath: String, val fileSize: Long? = null) : TelegramMediaFile

Photo

typealias Photo = PhotoFile

PhotoFile

@Serializable

@JvmInline

value class PhotoFile(val photos: List<PhotoSize>) : List<PhotoSize> , MediaContentVariant, UsefulAsPaidMediaFile

PhotoSerializer

object PhotoSerializer : KSerializer<PhotoFile>

PhotoSize

@Serializable

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

PlayableMediaFile

sealed interface PlayableMediaFile : TelegramMediaFile

RegularAnimatedSticker

@Serializable

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

RegularSimpleSticker

@Serializable

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

RegularSticker

@Serializable

sealed interface RegularSticker : Sticker

RegularVideoSticker

@Serializable

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

SizedMediaFile

sealed interface SizedMediaFile : TelegramMediaFile

Sticker

@Serializable(with = StickerSerializer::class)

sealed interface Sticker : TelegramMediaFile, SizedMediaFile, ThumbedMediaFile, MediaContentVariant

StickerSerializer

object StickerSerializer : KSerializer<Sticker>

StickerSurrogate

@Serializable

data class StickerSurrogate(val file_id: FileId, val file_unique_id: TgFileUniqueId, val type: StickerType, val width: Int, val height: Int, val is_animated: Boolean? = null, val is_video: Boolean? = null, val thumbnail: 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, val needs_repainting: Boolean = false)

TelegramMediaFile

sealed interface TelegramMediaFile

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

ThumbedMediaFile

sealed interface ThumbedMediaFile : TelegramMediaFile

TitledMediaFile

sealed interface TitledMediaFile

UnknownSticker

@Serializable

data class UnknownSticker(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val width: Int, val height: Int, val thumbnail: PhotoSize? = null, val emoji: String? = null, val stickerSetName: StickerSetName? = null, val fileSize: Long? = null, val stickerFormat: StickerFormat = StickerFormat.Static, val type: StickerType = StickerType.Regular, val raw: JsonElement) : Sticker

UsefulAsPaidMediaFile

sealed interface UsefulAsPaidMediaFile : MediaContentVariant

VideoFile

@Serializable

data class VideoFile(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val width: Int, val height: Int, val duration: Long? = null, val thumbnail: PhotoSize? = null, val cover: Photo? = null, val startTimestamp: Seconds? = null, val fileName: String? = null, val mimeType: MimeType? = null, val fileSize: Long? = null) : TelegramMediaFile, CustomNamedMediaFile, MimedMediaFile, CoveredMediaFile, CustomStartMediaFile, ThumbedMediaFile, PlayableMediaFile, SizedMediaFile, MediaContentVariant, UsefulAsPaidMediaFile

VideoNoteFile

@Serializable

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

VideoSticker

@Serializable

sealed interface VideoSticker : Sticker

VoiceFile

@Serializable

data class VoiceFile(val fileId: FileId, val fileUniqueId: TgFileUniqueId, val duration: Long? = null, val mimeType: MimeType? = null, val fileSize: Long? = null) : TelegramMediaFile, MimedMediaFile, PlayableMediaFile, MediaContentVariant

Functions

asAudioFile

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

asDocumentFile

inline fun TelegramMediaFile.asDocumentFile(): DocumentFile

asVoiceFile

fun AudioFile.asVoiceFile(): VoiceFile

biggest

fun PhotoFile.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, showCaptionAboveMedia: Boolean = false, startTimestamp: Seconds? = this.startTimestamp): TelegramMediaVideo

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

toTelegramPaidMediaVideo

inline fun VideoFile.toTelegramPaidMediaVideo(): TelegramPaidMediaVideo