docs/dev.inmo.tgbotapi.requests.abstracts

Package dev.inmo.tgbotapi.requests.abstracts

Types

FileId

data class FileId(fileId: String) : InputFile

Contains file id or file url

InputFile

sealed class InputFile

Common type for all files in Telegram Bot API which can be sent via requests like dev.inmo.tgbotapi.requests.send.media.SendDocument. You may use methods like MPPFile.asMultipartFile when you want to send files from your file system, but you should remember about restrictions[https://core.telegram.org/bots/api#sending-files] in Telegram for bots. In case you wish to send file by its url, use FileId and pass your url as FileId.fileId

InputFileSerializer

object InputFileSerializer : KSerializer<InputFile>

MultipartFile

data class MultipartFile(file: StorageFile, filename: String) : InputFile

Contains info about file for sending

MultipartRequest

interface MultipartRequest<T : Any> : Request<T>

Request

interface Request<T : Any>

SimpleRequest

interface SimpleRequest<T : Any> : Request<T>

Functions

asMultipartFile

expect suspend fun MPPFile.asMultipartFile(): MultipartFile

inline fun StorageFile.asMultipartFile(): MultipartFile

inline suspend fun ByteReadChannelAllocator.asMultipartFile(fileName: String): MultipartFile

inline suspend fun ByteReadChannel.asMultipartFile(fileName: String): MultipartFile

toInputFile

fun String.toInputFile(): FileId

fun File.toInputFile(): MultipartFile