Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
@Serializable
data class BotCommand(val command: String, val description: String)
Link copied to clipboard
Link copied to clipboard
@Serializable(with = ChatIdentifierSerializer::class)
data class ChatId(val chatId: Identifier) : ChatIdentifier

Also used as User Identifier

Link copied to clipboard
@Serializable(with = ChatIdentifierSerializer::class)
sealed class ChatIdentifier
Link copied to clipboard
Link copied to clipboard

Base interface for all chat invite links. See inheritors for more info or official docs

Link copied to clipboard
Link copied to clipboard
@Serializable
data class ChatInviteLinkUnlimited(val inviteLink: String, val creator: User, val name: String? = null, val isRevoked: Boolean = false, expireDate: TelegramDate? = null) : SecondaryChatInviteLink
Link copied to clipboard
@Serializable
data class ChatInviteLinkWithJoinRequest(val inviteLink: String, val creator: User, val name: String? = null, val leftToReview: Int = 0, val isRevoked: Boolean = false, expireDate: TelegramDate? = null) : SecondaryChatInviteLink

Represent SecondaryChatInviteLink which will require an aprovement from one of the administrators

Link copied to clipboard
@Serializable
data class ChatInviteLinkWithLimitedMembers(val inviteLink: String, val creator: User, val name: String? = null, val membersLimit: MembersLimit, val isRevoked: Boolean = false, expireDate: TelegramDate? = null) : SecondaryChatInviteLink

Represent SecondaryChatInviteLink which will have limitation for the amount of chat members to join

Link copied to clipboard
@Serializable
data class ChatLocation(val location: StaticLocation, val address: String)

Represents a location to which a chat is connected.

Link copied to clipboard
@Serializable
data class ChatPhoto(val smallFileId: String, val bigFileId: String, val smallFileUniqueId: FileUniqueId, val bigFileUniqueId: FileUniqueId)
Link copied to clipboard
@Serializable
data class Contact(val phoneNumber: String, val firstName: String, val lastName: String? = null, val userId: UserId? = null, val vcard: String? = null) : CommonContactData
Link copied to clipboard
@Serializable
value class CustomEmojiId(val string: String)
Link copied to clipboard
typealias Degrees = Int
Link copied to clipboard
typealias DiceResult = Int
Link copied to clipboard
typealias FileUniqueId = String
Link copied to clipboard
@Serializable
data class ForumTopic(val messageThreadId: MessageThreadId, val name: String, val color: RGBColor, val iconEmojiId: CustomEmojiId? = null)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias FoursquareId = String
Link copied to clipboard
Link copied to clipboard
typealias GooglePlaceId = String
Link copied to clipboard
Link copied to clipboard
typealias Identifier = Long
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Serializable
data class LoginURL(val url: String, val forwardText: String? = null, val botUsername: String? = null, val requestWriteAccess: Boolean? = null)
Link copied to clipboard
typealias LongSeconds = Long
Link copied to clipboard
Link copied to clipboard
typealias MembersLimit = Int
Link copied to clipboard
@Serializable(with = MenuButtonSerializer::class)
interface MenuButton
Link copied to clipboard
@Serializer(forClass = MenuButton::class)
object MenuButtonSerializer : KSerializer<MenuButton>
Link copied to clipboard
typealias MessageId = Long
Link copied to clipboard
Link copied to clipboard
object MessageIdSerializer : KSerializer<MessageId>
Link copied to clipboard
typealias MessageThreadId = Long
Link copied to clipboard
typealias Meters = Float
Link copied to clipboard
data class MigrateChatId(val newChatId: ChatId) : RequestError
Link copied to clipboard
typealias MilliSeconds = Long
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Serializable
data class PrimaryInviteLink(val inviteLink: String, val creator: User, val isRevoked: Boolean = false, expireDate: TelegramDate? = null) : ChatInviteLink

Primary invite link in the chat for this bot

Link copied to clipboard
sealed class RequestError
Link copied to clipboard
@Serializable
data class Response(val ok: Boolean = false, val description: String? = null, val errorCode: Int? = null, val result: JsonElement? = null, val parameters: ResponseParametersRaw? = null)
Link copied to clipboard
@Serializable
data class ResponseParametersRaw(migrateToChatId: ChatId? = null, retryAfter: Seconds? = null)
Link copied to clipboard
data class RetryAfterError(val seconds: Seconds, val startCountingMillis: Long) : RequestError
Link copied to clipboard

Base interface for all ChatInviteLinks which are NOT PrimaryInviteLink

Link copied to clipboard
typealias Seconds = Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@Serializable(with = StickerType.Serializer::class)
interface StickerType
Link copied to clipboard
@Serializable(with = TelegramDateSerializer::class)
data class TelegramDate(date: Long)
Link copied to clipboard
object TelegramDateSerializer : KSerializer<TelegramDate>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias UserId = ChatId
Link copied to clipboard
@Serializable(with = ChatIdentifierSerializer::class)
data class Username(val username: String) : ChatIdentifier
Link copied to clipboard
@Serializable
data class UserProfilePhotos(val count: Int, val photos: List<Photo>)
Link copied to clipboard
Link copied to clipboard
typealias WebAppQueryId = String
Link copied to clipboard
@Serializable
data class WebhookInfo(val url: String, val awaitDelivery: Int, val maxConnections: Int = 40, val customCertificate: Boolean = false, val allowedUpdates: List<String> = ALL_UPDATES_LIST, val lastErrorDate: TelegramDate? = null, val lastSynchronizationErrorDate: TelegramDate? = null, val lastErrorMessage: String? = null)

Functions

Link copied to clipboard
fun IetfLanguageCode?.javaLocale(): Locale?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
const val actionField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val addressField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val amountField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val audioField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val bioField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val captionField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val CHAT_MEMBER: String
Link copied to clipboard
Link copied to clipboard
const val chatField: String
Link copied to clipboard
const val chatIdField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val cityField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val creatorField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val dataField: String
Link copied to clipboard
Link copied to clipboard
const val dateField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val emailField: String
Link copied to clipboard
const val emojiField: String
Link copied to clipboard
const val emojisField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val errorsField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val fileField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val fileIdField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val filesField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val forceField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val fromField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val gifUrlField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val hashField: String
Link copied to clipboard
Link copied to clipboard
const val headingField: String
Link copied to clipboard
const val heightField: String
Link copied to clipboard
const val hideUrlField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val idField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val isBotField: String
Link copied to clipboard
Link copied to clipboard
const val isForumField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val isVideoField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val labelField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val lengthField: String
Link copied to clipboard
const val limitField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val mediaField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val messageField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val nameField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val nonceField: String
Link copied to clipboard
const val offsetField: String
Link copied to clipboard
const val okField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val optionsField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val payField: String
Link copied to clipboard
const val payloadField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val photoField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val pointField: String
Link copied to clipboard
const val pollIdField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val pricesField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val queryField: String
Link copied to clipboard
Link copied to clipboard
const val quizPollType: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val resultField: String
Link copied to clipboard
Link copied to clipboard
const val resultsField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val rightsField: String
Link copied to clipboard
const val scaleField: String
Link copied to clipboard
const val scopeField: String
Link copied to clipboard
const val scoreField: String
Link copied to clipboard
Link copied to clipboard
const val secretField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val selfieField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val sourceField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val stateField: String
Link copied to clipboard
const val statusField: String
Link copied to clipboard
const val stickerField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val textField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val thumbField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val titleField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val typeField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val UPDATE_POLL: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val urlField: String
Link copied to clipboard
const val userField: String
Link copied to clipboard
const val userIdField: String
Link copied to clipboard

https://core.telegram.org/bots/api#formatting-options

https://core.telegram.org/bots/api#formatting-options

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val usersField: String
Link copied to clipboard
Link copied to clipboard
const val valueField: String
Link copied to clipboard
const val vcardField: String
Link copied to clipboard
Link copied to clipboard
const val videoField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val voiceField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val webAppField: String
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val widthField: String
Link copied to clipboard
const val xShiftField: String
Link copied to clipboard
const val yShiftField: String