simbot-component-telegram-api/love.forte.simbot.telegram.api.message/ForwardMessagesApi

ForwardMessagesApi

class ForwardMessagesApi : SimpleBodyTelegramApi<List<MessageId>> (source)

Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Author

ForteScarlet

Types

Body

@Serializable

data class Body

Request body for ForwardMessagesApi.

Builder

class Builder

Builder for Body or ForwardMessagesApi.

Factory

object Factory

Properties

body

open override val body: Any

The request body (or null).

bodySerializationStrategy

open override val bodySerializationStrategy: SerializationStrategy<Any>?

A special deserialization for body. If it is null, then try to 'guess' the body serializer. This is usually overridden when the body is not null and you need to customize its serializer.

name

open override val name: String

The method name.

responseDeserializer

open override val responseDeserializer: DeserializationStrategy<List<MessageId>>

The result's DeserializationStrategy of this Method.

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<TelegramApiResult<List<MessageId>>>

The TelegramApiResult's DeserializationStrategy of this Method.

Inherited properties

headers

open val headers: Headers

Headers for request. Default is Headers.Empty.

Inherited functions

requestData

suspend fun <R : Any> TelegramApi<R>.requestData(client: HttpClient, token: String, server: Url?): R

suspend fun <R : Any> TelegramApi<R>.requestData(client: HttpClient, token: String, server: String? = null): R

Request the TelegramApi by client with token.

requestRaw

suspend fun TelegramApi<*>.requestRaw(client: HttpClient, token: String, server: Url?): HttpResponse

suspend fun TelegramApi<*>.requestRaw(client: HttpClient, token: String, server: String? = null): HttpResponse

Request the TelegramApi by client with token.

requestResult

suspend fun <R : Any> TelegramApi<R>.requestResult(client: HttpClient, token: String, server: Url?): TelegramApiResult<R>

suspend fun <R : Any> TelegramApi<R>.requestResult(client: HttpClient, token: String, server: String? = null): TelegramApiResult<R>

Request the TelegramApi by client with token.