Package dev.inmo.tgbotapi.types

Types

AuthorSignature

common

typealias AuthorSignature = ForwardSignature

Bot

common

sealed class Bot : User

BotCommand

common

data class BotCommand(command: String, description: String)

CallbackQueryIdentifier

common

typealias CallbackQueryIdentifier = String

ChatId

common

data class ChatId(chatId: Identifier) : ChatIdentifier

Also used as User Identifier

ChatIdentifier

common

sealed class ChatIdentifier

ChatInviteLink

common

sealed class ChatInviteLink

ChatInviteLinkSerializer

common

object ChatInviteLinkSerializer : KSerializer<ChatInviteLink>

ChatLocation

common

data class ChatLocation(location: StaticLocation, address: String)

Represents a location to which a chat is connected.

ChatMemberUpdated

common

data class ChatMemberUpdated(chat: Chat, user: User, date: TelegramDate, oldChatMemberState: ChatMember, newChatMemberState: ChatMember, inviteLink: ChatInviteLink?)

ChatPhoto

common

data class ChatPhoto(smallFileId: String, bigFileId: String, smallFileUniqueId: FileUniqueId, bigFileUniqueId: FileUniqueId)

CommonBot

common

data class CommonBot(id: UserId, username: Username, firstName: String, lastName: String) : Bot

CommonInviteLink

common

data class CommonInviteLink(inviteLink: String, creator: User, isRevoked: Boolean, expireDate: TelegramDate?, membersLimit: MembersLimit?) : ChatInviteLink

CommonUser

common

data class CommonUser(id: UserId, firstName: String, lastName: String, username: Username?, languageCode: String?) : User

Contact

common

data class Contact(phoneNumber: String, firstName: String, lastName: String?, userId: UserId?, vcard: String?) : CommonContactData

Degrees

common

typealias Degrees = Int

DiceResult

common

typealias DiceResult = Int

ExtendedBot

common

data class ExtendedBot(id: UserId, username: Username, firstName: String, lastName: String, canJoinGroups: Boolean, canReadAllGroupMessages: Boolean, supportsInlineQueries: Boolean) : Bot

ExtendedUser

common

typealias ExtendedUser = ExtendedPrivateChatImpl

FileUniqueId

common

typealias FileUniqueId = String

ForwardSenderName

common

typealias ForwardSenderName = String

ForwardSignature

common

typealias ForwardSignature = String

FoursquareId

common

typealias FoursquareId = String

FoursquareType

common

typealias FoursquareType = String

GooglePlaceId

common

typealias GooglePlaceId = String

GooglePlaceType

common

typealias GooglePlaceType = String

Identifier

common

typealias Identifier = Long

InlineMessageIdentifier

common

typealias InlineMessageIdentifier = String

InlineQueryIdentifier

common

typealias InlineQueryIdentifier = String

InvoicePayload

common

typealias InvoicePayload = String

LoginURL

common

data class LoginURL(url: String, forwardText: String?, botUsername: String?, requestWriteAccess: Boolean?)

LongSeconds

common

typealias LongSeconds = Long

MediaGroupIdentifier

common

typealias MediaGroupIdentifier = String

MembersLimit

common

typealias MembersLimit = Int

MessageIdentifier

common

typealias MessageIdentifier = Long

MessageIdSerializer

common

object MessageIdSerializer : KSerializer<MessageIdentifier>

Meters

common

typealias Meters = Float

MigrateChatId

common

data class MigrateChatId(newChatId: ChatId) : RequestError

MilliSeconds

common

typealias MilliSeconds = Long

PaymentQueryIdentifier

common

typealias PaymentQueryIdentifier = String

PollIdentifier

common

typealias PollIdentifier = String

PreCheckoutQueryId

common

typealias PreCheckoutQueryId = String

PrimaryInviteLink

common

data class PrimaryInviteLink(inviteLink: String, creator: User, isRevoked: Boolean, expireDate: TelegramDate?, membersLimit: MembersLimit?) : ChatInviteLink

RequestError

common

sealed class RequestError

Response

common

data class Response(ok: Boolean, description: String?, errorCode: Int?, result: JsonElement?, parameters: ResponseParametersRaw?)

ResponseParametersRaw

common

data class ResponseParametersRaw(migrateToChatId: ChatId?, retryAfter: Seconds?)

RetryAfterError

common

data class RetryAfterError(seconds: Seconds, startCountingMillis: Long) : RequestError

Seconds

common

typealias Seconds = Int

ShippingOptionIdentifier

common

typealias ShippingOptionIdentifier = String

ShippingQueryIdentifier

common

typealias ShippingQueryIdentifier = String

StartParameter

common

typealias StartParameter = String

StickerSetName

common

typealias StickerSetName = String

TelegramDate

common

data class TelegramDate(date: Long)

UnixTimeStamp

common

typealias UnixTimeStamp = LongSeconds

UpdateIdentifier

common

typealias UpdateIdentifier = Long

User

common

sealed class User : PrivateChat

UserId

common

typealias UserId = ChatId

Username

common

data class Username(username: String) : ChatIdentifier

UserProfilePhotos

common

data class UserProfilePhotos(count: Int, photos: List<Photo>)

WebhookInfo

common

data class WebhookInfo(url: String, awaitDelivery: Int, maxConnections: Int, customCertificate: Boolean, allowedUpdates: List<String>, lastErrorDate: TelegramDate?, lastErrorMessage: String?)

Functions

javaLocale

jvm

fun CommonUser.javaLocale(): Locale?

toChatId

common

fun Byte.toChatId(): ChatId

fun Int.toChatId(): ChatId

fun Identifier.toChatId(): ChatId

toTelegramDate

common

fun DateTime.toTelegramDate(): TelegramDate

toUsername

common

fun String.toUsername(): Username

Properties

actionField

common

const val actionField: String

addressField

common

const val addressField: String

ALL_UPDATES_LIST

common

val ALL_UPDATES_LIST: List<String>

allowedConnectionsLength

common

val allowedConnectionsLength: IntRange

allowedUpdatesField

common

const val allowedUpdatesField: String

allowSendingWithoutReplyField

common

const val allowSendingWithoutReplyField: String

allowsMultipleAnswersField

common

const val allowsMultipleAnswersField: String

amountField

common

const val amountField: String

animationField

common

const val animationField: String

audioDurationField

common

const val audioDurationField: String

audioField

common

const val audioField: String

audioFileIdField

common

const val audioFileIdField: String

audioUrlField

common

const val audioUrlField: String

bankStatementField

common

const val bankStatementField: String

basketballAndFootballDiceResultLimit

common

val basketballAndFootballDiceResultLimit: IntRange

bigFileIdField

common

const val bigFileIdField: String

bigFileUniqueIdField

common

const val bigFileUniqueIdField: String

bioField

common

const val bioField: String

botActionActualityTime

common

const val botActionActualityTime: Seconds = 5

botCommandDescriptionLimit

common

val botCommandDescriptionLimit: IntRange

botCommandField

common

const val botCommandField: String

botCommandLengthLimit

common

val botCommandLengthLimit: IntRange

botCommandLimit

common

val botCommandLimit: IntRange

BotCommandNameRegex

common

val BotCommandNameRegex: Regex

botCommandsField

common

const val botCommandsField: String

botCommandsLimit

common

val botCommandsLimit: IntRange

botUsernameField

common

const val botUsernameField: String

cacheTimeField

common

const val cacheTimeField: String

callbackDataField

common

const val callbackDataField: String

callbackGameField

common

const val callbackGameField: String

callbackQueryAnswerLength

common

val callbackQueryAnswerLength: IntRange

callbackQueryIdField

common

const val callbackQueryIdField: String

canAddWebPagePreviewsField

common

const val canAddWebPagePreviewsField: String

canBeEditedField

common

const val canBeEditedField: String

canChangeInfoField

common

const val canChangeInfoField: String

canDeleteMessagesField

common

const val canDeleteMessagesField: String

canEditMessagesField

common

const val canEditMessagesField: String

canInviteUsersField

common

const val canInviteUsersField: String

canJoinGroupsField

common

const val canJoinGroupsField: String

canManageChatField

common

const val canManageChatField: String

canManageVoiceChatsField

common

const val canManageVoiceChatsField: String

canPinMessagesField

common

const val canPinMessagesField: String

canPostMessagesField

common

const val canPostMessagesField: String

canPromoteMembersField

common

const val canPromoteMembersField: String

canReadAllGroupMessagesField

common

const val canReadAllGroupMessagesField: String

canRestrictMembersField

common

const val canRestrictMembersField: String

canSendMediaMessagesField

common

const val canSendMediaMessagesField: String

canSendMessagesField

common

const val canSendMessagesField: String

canSendOtherMessagesField

common

const val canSendOtherMessagesField: String

canSendPollsField

common

const val canSendPollsField: String

canSetStickerSetField

common

const val canSetStickerSetField: String

captionEntitiesField

common

const val captionEntitiesField: String

captionField

common

const val captionField: String

captionLength

common

val captionLength: IntRange

certificateField

common

const val certificateField: String

CHAT_MEMBER

common

const val CHAT_MEMBER: String

chatDescriptionLength

common

val chatDescriptionLength: IntRange

chatField

common

const val chatField: String

chatIdField

common

const val chatIdField: String

chatTitleLength

common

val chatTitleLength: IntRange

chatTypeField

common

const val chatTypeField: String

cityField

common

const val cityField: String

closeDateField

common

const val closeDateField: String

containsMasksField

common

const val containsMasksField: String

correctOptionIdField

common

const val correctOptionIdField: String

countryCodeField

common

const val countryCodeField: String

creatorField

common

const val creatorField: String

credentialsField

common

const val credentialsField: String

currencyField

common

const val currencyField: String

customTitleField

common

const val customTitleField: String

customTitleLength

common

val customTitleLength: IntRange

dartsCubeAndBowlingDiceResultLimit

common

val dartsCubeAndBowlingDiceResultLimit: IntRange

dataField

common

const val dataField: String

dataHashField

common

const val dataHashField: String

dateField

common

const val dateField: String

degreesLimit

common

val degreesLimit: IntRange

descriptionField

common

const val descriptionField: String

disableContentTypeDetectionField

common

const val disableContentTypeDetectionField: String

disableEditMessageField

common

const val disableEditMessageField: String

disableNotificationField

common

const val disableNotificationField: String

disableWebPagePreviewField

common

const val disableWebPagePreviewField: String

documentField

common

const val documentField: String

documentFileIdField

common

const val documentFileIdField: String

documentUrlField

common

const val documentUrlField: String

driverLicenseField

common

const val driverLicenseField: String

dropPendingUpdatesField

common

const val dropPendingUpdatesField: String

durationField

common

const val durationField: String

emailField

common

const val emailField: String

emojiField

common

const val emojiField: String

emojisField

common

const val emojisField: String

entitiesField

common

const val entitiesField: String

errorMessageField

common

const val errorMessageField: String

errorsField

common

const val errorsField: String

expireDateField

common

const val expireDateField: String

explanationEntitiesField

common

const val explanationEntitiesField: String

explanationField

common

const val explanationField: String

explanationLimit

common

val explanationLimit: IntRange

explanationParseModeField

common

const val explanationParseModeField: String

fieldNameField

common

const val fieldNameField: String

fileField

common

const val fileField: String

fileHashesField

common

const val fileHashesField: String

fileHashField

common

const val fileHashField: String

filesField

common

const val filesField: String

fileUniqueIdField

common

const val fileUniqueIdField: String

firstNameField

common

const val firstNameField: String

firstStreetLineField

common

const val firstStreetLineField: String

forceField

common

const val forceField: String

forwardTextField

common

const val forwardTextField: String

foursquareIdField

common

const val foursquareIdField: String

foursquareTypeField

common

const val foursquareTypeField: String

fromChatIdField

common

const val fromChatIdField: String

fromField

common

const val fromField: String

frontSideField

common

const val frontSideField: String

gameShortNameField

common

const val gameShortNameField: String

getUpdatesLimit

common

val getUpdatesLimit: IntRange

gifDurationField

common

const val gifDurationField: String

gifFileIdField

common

const val gifFileIdField: String

gifHeightField

common

const val gifHeightField: String

gifUrlField

common

const val gifUrlField: String

gifWidthField

common

const val gifWidthField: String

googlePlaceIdField

common

const val googlePlaceIdField: String

googlePlaceTypeField

common

const val googlePlaceTypeField: String

hasCustomCertificateField

common

const val hasCustomCertificateField: String

hashField

common

const val hashField: String

headingField

common

const val headingField: String

heightField

common

const val heightField: String

hideUrlField

common

const val hideUrlField: String

horizontalAccuracyField

common

const val horizontalAccuracyField: String

horizontalAccuracyLimit

common

val horizontalAccuracyLimit: ClosedFloatingPointRange<Float>

identityCardField

common

const val identityCardField: String

idField

common

const val idField: String

inlineKeyboardField

common

const val inlineKeyboardField: String

inlineMessageIdField

common

const val inlineMessageIdField: String

inlineQueryAnswerResultsLimit

common

val inlineQueryAnswerResultsLimit: IntRange

inlineQueryIdField

common

const val inlineQueryIdField: String

inlineResultQueryIdLingth

common

val inlineResultQueryIdLingth: IntRange

inputMessageContentField

common

const val inputMessageContentField: String

internalPassportField

common

const val internalPassportField: String

inviteLinkField

common

const val inviteLinkField: String

invoiceDescriptionLimit

common

val invoiceDescriptionLimit: IntRange

invoicePayloadBytesLimit

common

val invoicePayloadBytesLimit: IntRange

invoicePayloadField

common

const val invoicePayloadField: String

invoiceTitleLimit

common

val invoiceTitleLimit: IntRange

ipAddressField

common

const val ipAddressField: String

isAnimatedField

common

const val isAnimatedField: String

isAnonymousField

common

const val isAnonymousField: String

isBotField

common

const val isBotField: String

isClosedField

common

const val isClosedField: String

isMemberField

common

const val isMemberField: String

isPersonalField

common

const val isPersonalField: String

isPrimaryField

common

const val isPrimaryField: String

isRevokedField

common

const val isRevokedField: String

labelField

common

const val labelField: String

languageCodeField

common

const val languageCodeField: String

lastErrorDateField

common

const val lastErrorDateField: String

lastErrorMessageField

common

const val lastErrorMessageField: String

lastNameField

common

const val lastNameField: String

latitudeField

common

const val latitudeField: String

lengthField

common

const val lengthField: String

limitField

common

const val limitField: String

link

common

val Identifier.link: String

https://core.telegram.

link

common

val UserId.link: String

https://core.telegram.

link

common

val User.link: String

linkedChatIdField

common

const val linkedChatIdField: String

livePeriodField

common

const val livePeriodField: String

livePeriodLimit

common

val livePeriodLimit: IntRange

locationField

common

const val locationField: String

loginUrlField

common

const val loginUrlField: String

longitudeField

common

const val longitudeField: String

maskPositionField

common

const val maskPositionField: String

maxAllowedConnectionsField

common

const val maxAllowedConnectionsField: String

maxTipAmountField

common

const val maxTipAmountField: String

mediaCountInMediaGroup

common

val mediaCountInMediaGroup: IntRange

mediaField

common

const val mediaField: String

memberLimitField

common

const val memberLimitField: String

membersLimit

common

val membersLimit: IntRange

messageAutoDeleteTimeField

common

const val messageAutoDeleteTimeField: String

messageField

common

const val messageField: String

messageIdField

common

const val messageIdField: String

messageTextField

common

const val messageTextField: String

mpeg4GifDurationField

common

const val mpeg4GifDurationField: String

mpeg4GifFileIdField

common

const val mpeg4GifFileIdField: String

mpeg4GifHeightField

common

const val mpeg4GifHeightField: String

mpeg4GifUrlField

common

const val mpeg4GifUrlField: String

mpeg4GifWidthField

common

const val mpeg4GifWidthField: String

MY_CHAT_MEMBER

common

const val MY_CHAT_MEMBER: String

nameField

common

const val nameField: String

newChatMemberField

common

const val newChatMemberField: String

nextOffsetField

common

const val nextOffsetField: String

nonceField

common

const val nonceField: String

offsetField

common

const val offsetField: String

okField

common

const val okField: String

oldChatMemberField

common

const val oldChatMemberField: String

onlyIfBannedField

common

const val onlyIfBannedField: String

openPeriodField

common

const val openPeriodField: String

openPeriodPollSecondsLimit

common

val openPeriodPollSecondsLimit: IntRange

optionIdsField

common

const val optionIdsField: String

optionsField

common

const val optionsField: String

orderInfoField

common

const val orderInfoField: String

passportField

common

const val passportField: String

passportRegistrationField

common

const val passportRegistrationField: String

payField

common

const val payField: String

payloadField

common

const val payloadField: String

pendingUpdateCountField

common

const val pendingUpdateCountField: String

performerField

common

const val performerField: String

permissionsField

common

const val permissionsField: String

personalDetailsField

common

const val personalDetailsField: String

phoneNumberField

common

const val phoneNumberField: String

photoField

common

const val photoField: String

photoFileIdField

common

const val photoFileIdField: String

photoHeightField

common

const val photoHeightField: String

photoSizeField

common

const val photoSizeField: String

photoUrlField

common

const val photoUrlField: String

photoWidthField

common

const val photoWidthField: String

pinnedMessageField

common

const val pinnedMessageField: String

pngStickerField

common

const val pngStickerField: String

pointField

common

const val pointField: String

pollIdField

common

const val pollIdField: String

pollOptionsLimit

common

val pollOptionsLimit: IntRange

pollOptionTextLength

common

val pollOptionTextLength: IntRange

pollQuestionTextLength

common

val pollQuestionTextLength: IntRange

positionField

common

const val positionField: String

postCodeField

common

const val postCodeField: String

preCheckoutQueryIdField

common

const val preCheckoutQueryIdField: String

priceDependOnShipAddressField

common

const val priceDependOnShipAddressField: String

pricesField

common

const val pricesField: String

providerDataField

common

const val providerDataField: String

providerPaymentChargeIdField

common

const val providerPaymentChargeIdField: String

providerTokenField

common

const val providerTokenField: String

proximityAlertRadiusField

common

const val proximityAlertRadiusField: String

queryField

common

const val queryField: String

questionField

common

const val questionField: String

quizPollType

common

const val quizPollType: String

regularPollType

common

const val regularPollType: String

rentalAgreementField

common

const val rentalAgreementField: String

replyMarkupField

common

const val replyMarkupField: String

replyToMessageIdField

common

const val replyToMessageIdField: String

requestContactField

common

const val requestContactField: String

requestLocationField

common

const val requestLocationField: String

requestPollField

common

const val requestPollField: String

requestWriteAccessField

common

const val requestWriteAccessField: String

requireEmailField

common

const val requireEmailField: String

requireNameField

common

const val requireNameField: String

requirePhoneNumberField

common

const val requirePhoneNumberField: String

requireShippingAddressField

common

const val requireShippingAddressField: String

resultIdField

common

const val resultIdField: String

resultsField

common

const val resultsField: String

reverseSideField

common

const val reverseSideField: String

revokeMessagesField

common

const val revokeMessagesField: String

scaleField

common

const val scaleField: String

scoreField

common

const val scoreField: String

secondStreetLineField

common

const val secondStreetLineField: String

secretField

common

const val secretField: String

secureDataField

common

const val secureDataField: String

selfieField

common

const val selfieField: String

shippingAddressField

common

const val shippingAddressField: String

shippingOptionIdField

common

const val shippingOptionIdField: String

shippingOptionsField

common

const val shippingOptionsField: String

shippingQueryIdField

common

const val shippingQueryIdField: String

shouldSendEmailToProviderField

common

const val shouldSendEmailToProviderField: String

shouldSendPhoneNumberToProviderField

common

const val shouldSendPhoneNumberToProviderField: String

showAlertField

common

const val showAlertField: String

slotMachineDiceResultLimit

common

val slotMachineDiceResultLimit: IntRange

slowModeDelayField

common

const val slowModeDelayField: String

smallFileIdField

common

const val smallFileIdField: String

smallFileUniqueIdField

common

const val smallFileUniqueIdField: String

sourceField

common

const val sourceField: String

startDateField

common

const val startDateField: String

startParameterField

common

const val startParameterField: String

stateField

common

const val stateField: String

statusField

common

const val statusField: String

stickerField

common

const val stickerField: String

stickerFileIdField

common

const val stickerFileIdField: String

stickerSetNameField

common

const val stickerSetNameField: String

stickerSetNameFullField

common

const val stickerSetNameFullField: String

stickersField

common

const val stickersField: String

suggestedTipAmountsField

common

suggestedTipAmountsLimit

common

val suggestedTipAmountsLimit: IntRange

supportInlineQueriesField

common

const val supportInlineQueriesField: String

supportStreamingField

common

const val supportStreamingField: String

switchInlineQueryCurrentChatField

common

const val switchInlineQueryCurrentChatField: String

switchInlineQueryField

common

const val switchInlineQueryField: String

switchPmParameterField

common

const val switchPmParameterField: String

switchPmTextField

common

const val switchPmTextField: String

telegramInlineModeGifPermittedMimeTypes

common

val telegramInlineModeGifPermittedMimeTypes: List<MimeType>

telegramPaymentChargeIdField

common

const val telegramPaymentChargeIdField: String

temporaryRegistrationField

common

const val temporaryRegistrationField: String

textEntitiesField

common

const val textEntitiesField: String

textField

common

const val textField: String

textLength

common

val textLength: IntRange

tgsStickerField

common

const val tgsStickerField: String

thumbField

common

const val thumbField: String

thumbHeightField

common

const val thumbHeightField: String

thumbMimeTypeField

common

const val thumbMimeTypeField: String

thumbUrlField

common

const val thumbUrlField: String

thumbWidthField

common

const val thumbWidthField: String

titleField

common

const val titleField: String

totalAmountField

common

const val totalAmountField: String

totalVoterCountField

common

const val totalVoterCountField: String

translationField

common

const val translationField: String

translationFileField

common

const val translationFileField: String

translationFilesField

common

const val translationFilesField: String

typeField

common

const val typeField: String

unspecifiedField

common

const val unspecifiedField: String

untilDateField

common

const val untilDateField: String

UPDATE_CALLBACK_QUERY

common

const val UPDATE_CALLBACK_QUERY: String

UPDATE_CHANNEL_POST

common

const val UPDATE_CHANNEL_POST: String

UPDATE_CHOSEN_INLINE_RESULT

common

const val UPDATE_CHOSEN_INLINE_RESULT: String

UPDATE_EDITED_CHANNEL_POST

common

const val UPDATE_EDITED_CHANNEL_POST: String

UPDATE_EDITED_MESSAGE

common

const val UPDATE_EDITED_MESSAGE: String

UPDATE_INLINE_QUERY

common

const val UPDATE_INLINE_QUERY: String

UPDATE_MESSAGE

common

const val UPDATE_MESSAGE: String

UPDATE_POLL

common

const val UPDATE_POLL: String

UPDATE_POLL_ANSWER

common

const val UPDATE_POLL_ANSWER: String

UPDATE_PRE_CHECKOUT_QUERY

common

const val UPDATE_PRE_CHECKOUT_QUERY: String

UPDATE_SHIPPING_QUERY

common

const val UPDATE_SHIPPING_QUERY: String

updateIdField

common

const val updateIdField: String

urlField

common

const val urlField: String

userField

common

const val userField: String

userIdField

common

const val userIdField: String

usernameField

common

const val usernameField: String

userProfilePhotosRequestLimit

common

val userProfilePhotosRequestLimit: IntRange

usersField

common

const val usersField: String

utilityBillField

common

const val utilityBillField: String

valueField

common

const val valueField: String

vcardField

common

const val vcardField: String

videoDurationField

common

const val videoDurationField: String

videoField

common

const val videoField: String

videoFileIdField

common

const val videoFileIdField: String

videoHeightField

common

const val videoHeightField: String

videoNoteField

common

const val videoNoteField: String

videoUrlField

common

const val videoUrlField: String

videoWidthField

common

const val videoWidthField: String

voiceDurationField

common

const val voiceDurationField: String

voiceField

common

const val voiceField: String

voiceFileIdField

common

const val voiceFileIdField: String

voiceUrlField

common

const val voiceUrlField: String

votesCountField

common

const val votesCountField: String

widthField

common

const val widthField: String

xShiftField

common

const val xShiftField: String

yShiftField

common

const val yShiftField: String