tgbotapi.api/dev.inmo.tgbotapi.extensions.api

Package-level declarations

Types

data class EditLiveLocationInfo(val latitude: Double, val longitude: Double, val horizontalAccuracy: <Error class: unknown class>? = null, val heading: <Error class: unknown class>? = null, val proximityAlertRadius: <Error class: unknown class>? = null, val replyMarkup: <Error class: unknown class>? = null)

LiveLocationProvider

class LiveLocationProvider

Properties

defaultLivePeriodDelayMillis

const val defaultLivePeriodDelayMillis: Long

indefiniteLivePeriodDelayMillis

const val indefiniteLivePeriodDelayMillis: Long

Functions

buildBot

fun buildBot(token: String, apiUrl: String = telegramBotAPIDefaultUrl, testServer: Boolean = false, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, block: BotBuilder.() -> Unit): <Error class: unknown class>

delete

suspend fun <Error class: unknown class>.delete(requestsExecutor: <Error class: unknown class>)

suspend fun <Error class: unknown class>.delete(message: <Error class: unknown class>)

suspend fun <Error class: unknown class>.delete(messages: List<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.delete(messagesMetas: List<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.delete(chatId: <Error class: unknown class>, messageId: <Error class: unknown class>)

suspend fun <Error class: unknown class>.delete(chatId: <Error class: unknown class>, messageIds: Array<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.delete(chatId: <Error class: unknown class>, messageIds: List<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.delete(chat: <Error class: unknown class>, messageId: <Error class: unknown class>)

deleteMessage

suspend fun <Error class: unknown class>.deleteMessage(message: <Error class: unknown class>)

suspend fun <Error class: unknown class>.deleteMessage(chatId: <Error class: unknown class>, messageId: <Error class: unknown class>)

suspend fun <Error class: unknown class>.deleteMessage(chat: <Error class: unknown class>, messageId: <Error class: unknown class>)

deleteMessages

suspend fun <Error class: unknown class>.deleteMessages(messages: List<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.deleteMessages(messagesMetas: List<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.deleteMessages(chatId: <Error class: unknown class>, messageIds: Array<<Error class: unknown class>>)

suspend fun <Error class: unknown class>.deleteMessages(chatId: <Error class: unknown class>, messageIds: List<<Error class: unknown class>>)

executeClose

inline suspend fun <Error class: unknown class>.executeClose()

forward

suspend fun <Error class: unknown class>.forward(toChatId: <Error class: unknown class>, messages: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forward(toChatId: <Error class: unknown class>, messagesMetas: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forward(toChatId: <Error class: unknown class>, fromChatId: <Error class: unknown class>, messageIds: Array<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forward(toChatId: <Error class: unknown class>, fromChatId: <Error class: unknown class>, messageIds: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

forwardMessage

suspend fun <Error class: unknown class>.forwardMessage(toChatId: <Error class: unknown class>, message: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.forwardMessage(toChat: <Error class: unknown class>, message: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChat.id.threadId, directMessageThreadId: <Error class: unknown class>? = toChat.id.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.forwardMessage(fromChatId: <Error class: unknown class>, toChatId: <Error class: unknown class>, messageId: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.forwardMessage(fromChatId: <Error class: unknown class>, toChat: <Error class: unknown class>, messageId: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChat.id.threadId, directMessageThreadId: <Error class: unknown class>? = toChat.id.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.forwardMessage(fromChat: <Error class: unknown class>, toChatId: <Error class: unknown class>, messageId: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.forwardMessage(fromChat: <Error class: unknown class>, toChat: <Error class: unknown class>, messageId: <Error class: unknown class>, threadId: <Error class: unknown class>? = toChat.id.threadId, directMessageThreadId: <Error class: unknown class>? = toChat.id.directMessageThreadId, startTimestamp: <Error class: unknown class>? = null, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: <Error class: unknown class>? = null): <Error class: unknown class>

forwardMessages

suspend fun <Error class: unknown class>.forwardMessages(toChatId: <Error class: unknown class>, messages: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forwardMessages(toChatId: <Error class: unknown class>, messagesMetas: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forwardMessages(toChatId: <Error class: unknown class>, fromChatId: <Error class: unknown class>, messageIds: Array<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.forwardMessages(toChatId: <Error class: unknown class>, fromChatId: <Error class: unknown class>, messageIds: List<<Error class: unknown class>>, threadId: <Error class: unknown class>? = toChatId.threadId, directMessageThreadId: <Error class: unknown class>? = toChatId.directMessageThreadId, disableNotification: Boolean = false, protectContent: Boolean = false, removeCaption: Boolean = false): List<<Error class: unknown class>>

getRawUpdates

suspend fun <Error class: unknown class>.getRawUpdates(offset: <Error class: unknown class>? = null, limit: Int = getUpdatesLimit.last, timeout: <Error class: unknown class>? = null, allowed_updates: List<String>? = ALL_UPDATES_LIST): <Error class: unknown class>

suspend fun <Error class: unknown class>.getRawUpdates(lastUpdate: <Error class: unknown class>, limit: Int = getUpdatesLimit.last, timeout: <Error class: unknown class>? = null, allowed_updates: List<String>? = ALL_UPDATES_LIST): <Error class: unknown class>

getUpdates

suspend fun <Error class: unknown class>.getUpdates(offset: <Error class: unknown class>? = null, limit: Int = getUpdatesLimit.last, timeout: <Error class: unknown class>? = null, allowed_updates: List<String>? = ALL_UPDATES_LIST): List<<Error class: unknown class>>

suspend fun <Error class: unknown class>.getUpdates(lastUpdate: <Error class: unknown class>, limit: Int = getUpdatesLimit.last, timeout: <Error class: unknown class>? = null, allowed_updates: List<String>? = ALL_UPDATES_LIST): List<<Error class: unknown class>>

handleLiveLocation

suspend fun <Error class: unknown class>.handleLiveLocation(chatId: <Error class: unknown class>, locationsFlow: Flow<<Error class: unknown class>>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, threadId: <Error class: unknown class>? = chatId.threadId, directMessageThreadId: <Error class: unknown class>? = chatId.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, sentMessageFlow: FlowCollector<<Error class: unknown class><<Error class: unknown class>>>? = null)

suspend fun <Error class: unknown class>.handleLiveLocation(chatId: <Error class: unknown class>, locationsFlow: Flow<<Error class: unknown class><Double, Double>>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, threadId: <Error class: unknown class>? = chatId.threadId, directMessageThreadId: <Error class: unknown class>? = chatId.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, sentMessageFlow: FlowCollector<<Error class: unknown class><<Error class: unknown class>>>? = null)

Will apply Flow.map to the locationsFlow to create EditLiveLocationInfo and pass the result flow to the handleLiveLocation with Flow typed by EditLiveLocationInfo

suspend fun <Error class: unknown class>.handleLiveLocation(chatId: <Error class: unknown class>, locationsFlow: Flow<EditLiveLocationInfo>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, threadId: <Error class: unknown class>? = chatId.threadId, directMessageThreadId: <Error class: unknown class>? = chatId.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, sentMessageFlow: FlowCollector<<Error class: unknown class><<Error class: unknown class>>>? = null)

Will sendLiveLocation with the first EditLiveLocationInfo data and update than. Each liveTimeMillis passing, the message will be sent again and new edits will be applied to the new message

logOut

inline suspend fun <Error class: unknown class>.logOut()

replyWithLiveLocation

inline suspend fun <Error class: unknown class>.replyWithLiveLocation(to: <Error class: unknown class>, scope: CoroutineScope, location: <Error class: unknown class>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = to.threadIdOrNull, directMessageThreadId: <Error class: unknown class>? = to.directMessageThreadIdOrNull, businessConnectionId: <Error class: unknown class>? = to.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

inline suspend fun <Error class: unknown class>.replyWithLiveLocation(to: <Error class: unknown class>, scope: CoroutineScope, latitude: Double, longitude: Double, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = to.threadIdOrNull, directMessageThreadId: <Error class: unknown class>? = to.directMessageThreadIdOrNull, businessConnectionId: <Error class: unknown class>? = to.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

startLiveLocation

suspend fun <Error class: unknown class>.startLiveLocation(scope: CoroutineScope, chat: <Error class: unknown class>, location: <Error class: unknown class>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = chat.id.threadId, directMessageThreadId: <Error class: unknown class>? = chat.id.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chat.id.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

suspend fun <Error class: unknown class>.startLiveLocation(scope: CoroutineScope, chatId: <Error class: unknown class>, location: <Error class: unknown class>, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = chatId.threadId, directMessageThreadId: <Error class: unknown class>? = chatId.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

suspend fun <Error class: unknown class>.startLiveLocation(scope: CoroutineScope, chatId: <Error class: unknown class>, latitude: Double, longitude: Double, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = chatId.threadId, directMessageThreadId: <Error class: unknown class>? = chatId.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

suspend fun <Error class: unknown class>.startLiveLocation(scope: CoroutineScope, chat: <Error class: unknown class>, latitude: Double, longitude: Double, liveTimeMillis: Long = defaultLivePeriodDelayMillis, initHorizontalAccuracy: <Error class: unknown class>? = null, initHeading: <Error class: unknown class>? = null, initProximityAlertRadius: <Error class: unknown class>? = null, threadId: <Error class: unknown class>? = chat.id.threadId, directMessageThreadId: <Error class: unknown class>? = chat.id.directMessageThreadId, businessConnectionId: <Error class: unknown class>? = chat.id.businessConnectionId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: Boolean = false, effectId: <Error class: unknown class>? = null, suggestedPostParameters: <Error class: unknown class>? = null, replyParameters: <Error class: unknown class>? = null, replyMarkup: <Error class: unknown class>? = null): LiveLocationProvider

stopPoll

suspend fun <Error class: unknown class>.stopPoll(chatId: <Error class: unknown class>, messageId: <Error class: unknown class>, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, replyMarkup: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.stopPoll(chat: <Error class: unknown class>, message: <Error class: unknown class>, businessConnectionId: <Error class: unknown class>? = chat.id.businessConnectionId, replyMarkup: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.stopPoll(chat: <Error class: unknown class>, messageId: <Error class: unknown class>, businessConnectionId: <Error class: unknown class>? = chat.id.businessConnectionId, replyMarkup: <Error class: unknown class>? = null): <Error class: unknown class>

suspend fun <Error class: unknown class>.stopPoll(chatId: <Error class: unknown class>, message: <Error class: unknown class>, businessConnectionId: <Error class: unknown class>? = chatId.businessConnectionId, replyMarkup: <Error class: unknown class>? = null): <Error class: unknown class>

telegramBot

fun telegramBot(urlsKeeper: <Error class: unknown class>, client: <Error class: unknown class> = HttpClient(defaultKtorEngine)): <Error class: unknown class>

Allows to create bot using bot urlsKeeper and already prepared client

inline fun telegramBot(urlsKeeper: <Error class: unknown class>, noinline clientConfig: <Error class: unknown class><out <Error class: unknown class>>.() -> Unit): <Error class: unknown class>

Allows to create bot using bot urlsKeeper and specify HttpClientEngine by configuring HttpClient using clientConfig

inline fun <T> telegramBot(urlsKeeper: <Error class: unknown class>, clientFactory: <Error class: unknown class><T>, noinline clientConfig: <Error class: unknown class><T>.() -> Unit = {}): <Error class: unknown class>

Allows to create bot using bot urlsKeeper and specify HttpClientEngineFactory by passing clientFactory param and optionally configure it with clientConfig

inline fun telegramBot(urlsKeeper: <Error class: unknown class>, clientEngine: <Error class: unknown class>, noinline clientConfig: <Error class: unknown class><out <Error class: unknown class>>.() -> Unit = {}): <Error class: unknown class>

Allows to create bot using bot urlsKeeper and specify HttpClientEngine by passing clientEngine param and optionally configure HttpClient using clientConfig

fun telegramBot(token: String, apiUrl: String = telegramBotAPIDefaultUrl, testServer: Boolean = false, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, client: <Error class: unknown class> = HttpClient(defaultKtorEngine)): <Error class: unknown class>

Allows to create bot using bot token, apiUrl (for custom api servers) and already prepared client

fun telegramBot(token: String, apiUrl: String = telegramBotAPIDefaultUrl, testServer: Boolean = false, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, clientConfig: <Error class: unknown class><out <Error class: unknown class>>.() -> Unit): <Error class: unknown class>

Allows to create bot using bot token and apiUrl and specify HttpClientEngine by configuring HttpClient using clientConfig

fun <T> telegramBot(token: String, clientFactory: <Error class: unknown class><T>, apiUrl: String = telegramBotAPIDefaultUrl, testServer: Boolean = false, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, clientConfig: <Error class: unknown class><T>.() -> Unit = {}): <Error class: unknown class>

fun telegramBot(token: String, clientEngine: <Error class: unknown class>, apiUrl: String = telegramBotAPIDefaultUrl, testServer: Boolean = false, fileLinkUrlMapper: <Error class: unknown class>.(String) -> String = { "${fileBaseUrl}/$it" }, clientConfig: <Error class: unknown class><out <Error class: unknown class>>.() -> Unit = {}): <Error class: unknown class>

Allows to create bot using bot token and specify HttpClientEngine by passing clientEngine param and optionally configure HttpClient using clientConfig