Package dev.inmo.tgbotapi.requests.abstracts

Types

FileId
Link copied to clipboard
data class FileId(fileId: String) : InputFile

Contains file id or file url

InputFile
Link copied to clipboard
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
Link copied to clipboard
object InputFileSerializer : KSerializer<InputFile>
MultipartFile
Link copied to clipboard
data class MultipartFile(file: StorageFile, filename: String) : InputFile

Contains info about file for sending

MultipartRequest
Link copied to clipboard
interface MultipartRequest<T : Any> : Request<T>
Request
Link copied to clipboard
interface Request<T : Any>
SimpleRequest
Link copied to clipboard
interface SimpleRequest<T : Any> : Request<T>

Functions

asMultipartFile
Link copied to clipboard
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
Link copied to clipboard
fun String.toInputFile(): FileId
fun File.toInputFile(): MultipartFile