tgbotapi.core/dev.inmo.tgbotapi.requests

Package-level declarations

Types

@Serializable

data class DeleteMessage(val chatId: ChatIdentifier, val messageId: MessageId) : SimpleRequest<Boolean> , MessageAction

@Serializable

data class DeleteMessages(val chatId: ChatIdentifier, val messageIds: List<MessageId>) : SimpleRequest<Boolean> , MessagesAction

DownloadFile

class DownloadFile(val filePath: String) : Request<ByteArray>

DownloadFileStream

class DownloadFileStream(val filePath: String) : Request<ByteReadChannelAllocator>

ForwardMessage

@Serializable

data class ForwardMessage(val fromChatId: ChatIdentifier, val toChatId: ChatIdentifier, val messageId: MessageId, val threadId: MessageThreadId? = toChatId.threadId, val startTimestamp: Seconds? = null, val disableNotification: Boolean = false, val protectContent: Boolean = false) : SimpleRequest<PossiblyForwardedMessage> , MessageAction, ProtectContent, OptionallyMessageThreadRequest, WithCustomStartMediaData

ForwardMessages

@Serializable

data class ForwardMessages(val toChatId: ChatIdentifier, val fromChatId: ChatIdentifier, val messageIds: List<MessageId>, val threadId: MessageThreadId? = toChatId.threadId, val disableNotification: Boolean = false, val protectContent: Boolean = false, removeCaption: Boolean = false) : SimpleRequest<List<MessageId>> , MessagesAction, ProtectContent, OptionallyMessageThreadRequest, DisableNotification

GetUpdates

@Serializable

data class GetUpdates(val offset: UpdateId? = null, val limit: Int = getUpdatesLimit.last, val timeout: Seconds? = null, val allowed_updates: List<String>? = ALL_UPDATES_LIST) : GetUpdatesRequest<List<Update>>

Request updates from Telegram Bot API system. It is important, that the result updates WILL NOT include dev.inmo.tgbotapi.types.update.MediaGroupUpdates.MediaGroupUpdate objects due to the fact, that it is internal abstraction and in fact any dev.inmo.tgbotapi.types.message.abstracts.MediaGroupMessage is just a common dev.inmo.tgbotapi.types.message.abstracts.AccessibleMessage

GetUpdatesRaw

@Serializable

data class GetUpdatesRaw(val offset: UpdateId? = null, val limit: Int = getUpdatesLimit.last, val timeout: Seconds? = null, val allowed_updates: List<String>? = ALL_UPDATES_LIST) : GetUpdatesRequest<JsonArray>

Raw variant of GetUpdates. This type will be useful in case you wish to get some updates and handle them by yourself or with dev.inmo.tgbotapi.utils.convertWithMediaGroupUpdates

GetUpdatesRequest

interface GetUpdatesRequest<T : Any> : SimpleRequest<T>

SetPassportDataErrors

@Serializable

data class SetPassportDataErrors(val user: UserId, val errors: List<PassportElementError>) : SimpleRequest<Boolean>

StopPoll

@Serializable

data class StopPoll(val chatId: ChatIdentifier, val messageId: MessageId, val businessConnectionId: BusinessConnectionId? = chatId.businessConnectionId, val replyMarkup: InlineKeyboardMarkup? = null) : MessageAction, SimpleRequest<Poll> , WithReplyMarkup, OptionallyBusinessConnectionRequest

Functions

ForwardMessages

fun ForwardMessages(toChatId: ChatIdentifier, fromChatId: ChatIdentifier, messageIds: Array<MessageId>, threadId: MessageThreadId? = toChatId.threadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): ForwardMessages