docs / com.github.insanusmokrassar.TelegramBotAPI.types

Package com.github.insanusmokrassar.TelegramBotAPI.types

Types

(common)

AuthorSignature

typealias AuthorSignature = ForwardSignature
(common)

Bot

sealed class Bot : User
(common)

BotCommand

data class BotCommand
(common)

CallbackQueryIdentifier

typealias CallbackQueryIdentifier = String
(common)

ChatId

Also used as User Identifier

data class ChatId : ChatIdentifier
(common)

ChatIdentifier

sealed class ChatIdentifier
(common)

ChatPhoto

data class ChatPhoto
(common)

CommonBot

data class CommonBot : Bot
(common)

CommonUser

data class CommonUser : User
(common)

Contact

data class Contact : CommonContactData
(common)

Dice

typealias Dice = Dice
(common)

DiceResult

typealias DiceResult = Int
(common)

ExtendedBot

data class ExtendedBot : Bot
(common)

ExtendedUser

typealias ExtendedUser = ExtendedPrivateChatImpl
(common)

FileUniqueId

typealias FileUniqueId = String
(common)

ForwardSenderName

typealias ForwardSenderName = String
(common)

ForwardSignature

typealias ForwardSignature = String
(common)

Identifier

typealias Identifier = Long
(common)

InlineMessageIdentifier

typealias InlineMessageIdentifier = String
(common)

InlineQueryIdentifier

typealias InlineQueryIdentifier = String
(common)

InvoicePayload

typealias InvoicePayload = String
(common)

Location

data class Location : Locationed
(common)

LoginURL

data class LoginURL
(common)

LongSeconds

typealias LongSeconds = Long
(common)

MediaGroupIdentifier

typealias MediaGroupIdentifier = String
(common)

MessageIdentifier

typealias MessageIdentifier = Long
(common)

MigrateChatId

data class MigrateChatId : RequestError
(common)

PaymentQueryIdentifier

typealias PaymentQueryIdentifier = String
(common)

PollIdentifier

typealias PollIdentifier = String
(common)

PreCheckoutQueryId

typealias PreCheckoutQueryId = String
(common)

RequestError

sealed class RequestError
(common)

Response

data class Response
(common)

ResponseParametersRaw

data class ResponseParametersRaw
(common)

RetryAfterError

data class RetryAfterError : RequestError
(common)

Seconds

typealias Seconds = Int
(common)

ShippingOptionIdentifier

typealias ShippingOptionIdentifier = String
(common)

ShippingQueryIdentifier

typealias ShippingQueryIdentifier = String
(common)

StartParameter

typealias StartParameter = String
(common)

StickerSetName

typealias StickerSetName = String
(common)

TelegramDate

data class TelegramDate
(common)

UpdateIdentifier

typealias UpdateIdentifier = Long
(common)

User

sealed class User : PrivateChat
(common)

UserId

typealias UserId = ChatId
(common)

Username

data class Username : ChatIdentifier
(common)

UserProfilePhotos

data class UserProfilePhotos
(common)

Venue

data class Venue : CommonVenueData
(common)

WebhookInfo

data class WebhookInfo

Extensions for External Classes

(common)

com.soywiz.klock.DateTime

(common)

kotlin.Byte

(common)

kotlin.Int

(common)

kotlin.Long

(common)

kotlin.String

Properties

(common)

actionField

const val actionField: String
(common)

addressField

const val addressField: String
(common)

ALL_UPDATES_LIST

val ALL_UPDATES_LIST: List<String>
(common)

allowedConnectionsLength

val allowedConnectionsLength: IntRange
(common)

allowedUpdatesField

const val allowedUpdatesField: String
(common)

allowsMultipleAnswersField

const val allowsMultipleAnswersField: String
(common)

amountField

const val amountField: String
(common)

animationField

const val animationField: String
(common)

audioDurationField

const val audioDurationField: String
(common)

audioField

const val audioField: String
(common)

audioFileIdField

const val audioFileIdField: String
(common)

audioUrlField

const val audioUrlField: String
(common)

bigFileIdField

const val bigFileIdField: String
(common)

bigFileUniqueIdField

const val bigFileUniqueIdField: String
(common)

botCommandDescriptionLimit

val botCommandDescriptionLimit: IntRange
(common)

botCommandField

const val botCommandField: String
(common)

botCommandLengthLimit

val botCommandLengthLimit: IntRange
(common)

botCommandLimit

val botCommandLimit: IntRange
(common)

BotCommandNameRegex

val BotCommandNameRegex: Regex
(common)

botCommandsField

const val botCommandsField: String
(common)

botCommandsLimit

val botCommandsLimit: IntRange
(common)

botUsernameField

const val botUsernameField: String
(common)

cachedTimeField

const val cachedTimeField: String
(common)

callbackDataField

const val callbackDataField: String
(common)

callbackGameField

const val callbackGameField: String
(common)

callbackQueryAnswerLength

val callbackQueryAnswerLength: IntRange
(common)

callbackQueryIdField

const val callbackQueryIdField: String
(common)

canAddWebPagePreviewsField

const val canAddWebPagePreviewsField: String
(common)

canBeEditedField

const val canBeEditedField: String
(common)

canChangeInfoField

const val canChangeInfoField: String
(common)

canDeleteMessagesField

const val canDeleteMessagesField: String
(common)

canEditMessagesField

const val canEditMessagesField: String
(common)

canInviteUsersField

const val canInviteUsersField: String
(common)

canJoinGroupsField

const val canJoinGroupsField: String
(common)

canPinMessagesField

const val canPinMessagesField: String
(common)

canPostMessagesField

const val canPostMessagesField: String
(common)

canPromoteMembersField

const val canPromoteMembersField: String
(common)

canReadAllGroupMessagesField

const val canReadAllGroupMessagesField: String
(common)

canRestrictMembersField

const val canRestrictMembersField: String
(common)

canSendMediaMessagesField

const val canSendMediaMessagesField: String
(common)

canSendMessagesField

const val canSendMessagesField: String
(common)

canSendOtherMessagesField

const val canSendOtherMessagesField: String
(common)

canSendPollsField

const val canSendPollsField: String
(common)

canSetStickerSetField

const val canSetStickerSetField: String
(common)

captionField

const val captionField: String
(common)

captionLength

val captionLength: IntRange
(common)

certificateField

const val certificateField: String
(common)

chatDescriptionLength

val chatDescriptionLength: IntRange
(common)

chatField

const val chatField: String
(common)

chatIdField

const val chatIdField: String
(common)

chatTitleLength

val chatTitleLength: IntRange
(common)

cityField

const val cityField: String
(common)

closeDateField

const val closeDateField: String
(common)

containsMasksField

const val containsMasksField: String
(common)

correctOptionIdField

const val correctOptionIdField: String
(common)

countryCodeField

const val countryCodeField: String
(common)

currencyField

const val currencyField: String
(common)

customTitleField

const val customTitleField: String
(common)

customTitleLength

val customTitleLength: IntRange
(common)

dateField

const val dateField: String
(common)

descriptionField

const val descriptionField: String
(common)

diceResultLimit

val diceResultLimit: IntRange
(common)

disableEditMessageField

const val disableEditMessageField: String
(common)

disableNotificationField

const val disableNotificationField: String
(common)

disableWebPagePreviewField

const val disableWebPagePreviewField: String
(common)

documentField

const val documentField: String
(common)

documentFileIdField

const val documentFileIdField: String
(common)

documentUrlField

const val documentUrlField: String
(common)

durationField

const val durationField: String
(common)

emailField

const val emailField: String
(common)

emojiField

const val emojiField: String
(common)

emojisField

const val emojisField: String
(common)

errorMessageField

const val errorMessageField: String
(common)

explanationEntitiesField

const val explanationEntitiesField: String
(common)

explanationField

const val explanationField: String
(common)

explanationLimit

val explanationLimit: IntRange
(common)

explanationParseModeField

const val explanationParseModeField: String
(common)

fileUniqueIdField

const val fileUniqueIdField: String
(common)

firstNameField

const val firstNameField: String
(common)

firstStreetLineField

const val firstStreetLineField: String
(common)

forceField

const val forceField: String
(common)

forwardTextField

const val forwardTextField: String
(common)

foursquareIdField

const val foursquareIdField: String
(common)

foursquareTypeField

const val foursquareTypeField: String
(common)

fromChatIdField

const val fromChatIdField: String
(common)

fromField

const val fromField: String
(common)

gameShortNameField

const val gameShortNameField: String
(common)

getUpdatesLimit

val getUpdatesLimit: IntRange
(common)

gifDurationField

const val gifDurationField: String
(common)

gifFileIdField

const val gifFileIdField: String
(common)

gifHeightField

const val gifHeightField: String
(common)

gifUrlField

const val gifUrlField: String
(common)

gifWidthField

const val gifWidthField: String
(common)

hasCustomCertificateField

const val hasCustomCertificateField: String
(common)

heightField

const val heightField: String
(common)

hideUrlField

const val hideUrlField: String
(common)

idField

const val idField: String
(common)

inlineKeyboardField

const val inlineKeyboardField: String
(common)

inlineMessageIdField

const val inlineMessageIdField: String
(common)

inlineQueryAnswerResultsLimit

val inlineQueryAnswerResultsLimit: IntRange
(common)

inlineQueryIdField

const val inlineQueryIdField: String
(common)

inlineResultQueryIdLingth

val inlineResultQueryIdLingth: IntRange
(common)

inputMessageContentField

const val inputMessageContentField: String
(common)

inviteLinkField

const val inviteLinkField: String
(common)

invoiceDescriptionLimit

val invoiceDescriptionLimit: IntRange
(common)

invoicePayloadBytesLimit

val invoicePayloadBytesLimit: IntRange
(common)

invoicePayloadField

const val invoicePayloadField: String
(common)

invoiceTitleLimit

val invoiceTitleLimit: IntRange
(common)

isAnimatedField

const val isAnimatedField: String
(common)

isAnonymousField

const val isAnonymousField: String
(common)

isBotField

const val isBotField: String
(common)

isClosedField

const val isClosedField: String
(common)

isMemberField

const val isMemberField: String
(common)

isPersonalField

const val isPersonalField: String
(common)

labelField

const val labelField: String
(common)

languageCodeField

const val languageCodeField: String
(common)

lastErrorDateField

const val lastErrorDateField: String
(common)

lastErrorMessageField

const val lastErrorMessageField: String
(common)

lastNameField

const val lastNameField: String
(common)

latitudeField

const val latitudeField: String
(common)

lengthField

const val lengthField: String
(common)

limitField

const val limitField: String
(common)

link

val ChatId.link: String
(common)

livePeriodField

const val livePeriodField: String
(common)

livePeriodLimit

val livePeriodLimit: IntRange
(common)

locationField

const val locationField: String
(common)

loginUrlField

const val loginUrlField: String
(common)

longitudeField

const val longitudeField: String
(common)

maskPositionField

const val maskPositionField: String
(common)

maxAllowedConnectionsField

const val maxAllowedConnectionsField: String
(common)

mediaCountInMediaGroup

val mediaCountInMediaGroup: IntRange
(common)

mediaField

const val mediaField: String
(common)

messageIdField

const val messageIdField: String
(common)

messageTextField

const val messageTextField: String
(common)

mpeg4GifDurationField

const val mpeg4GifDurationField: String
(common)

mpeg4GifFileIdField

const val mpeg4GifFileIdField: String
(common)

mpeg4GifHeightField

const val mpeg4GifHeightField: String
(common)

mpeg4GifUrlField

const val mpeg4GifUrlField: String
(common)

mpeg4GifWidthField

const val mpeg4GifWidthField: String
(common)

nameField

const val nameField: String
(common)

nextOffsetField

const val nextOffsetField: String
(common)

offsetField

const val offsetField: String
(common)

okField

const val okField: String
(common)

openPeriodField

const val openPeriodField: String
(common)

openPeriodPollSecondsLimit

val openPeriodPollSecondsLimit: IntRange
(common)

optionIdsField

const val optionIdsField: String
(common)

optionsField

const val optionsField: String
(common)

orderInfoField

const val orderInfoField: String
(common)

payField

const val payField: String
(common)

payloadField

const val payloadField: String
(common)

pendingUpdateCountField

const val pendingUpdateCountField: String
(common)

performerField

const val performerField: String
(common)

permissionsField

const val permissionsField: String
(common)

phoneNumberField

const val phoneNumberField: String
(common)

photoField

const val photoField: String
(common)

photoFileIdField

const val photoFileIdField: String
(common)

photoHeightField

const val photoHeightField: String
(common)

photoSizeField

const val photoSizeField: String
(common)

photoUrlField

const val photoUrlField: String
(common)

photoWidthField

const val photoWidthField: String
(common)

pinnedMessageField

const val pinnedMessageField: String
(common)

pngStickerField

const val pngStickerField: String
(common)

pointField

const val pointField: String
(common)

pollIdField

const val pollIdField: String
(common)

pollOptionsLimit

val pollOptionsLimit: IntRange
(common)

pollOptionTextLength

val pollOptionTextLength: IntRange
(common)

pollQuestionTextLength

val pollQuestionTextLength: IntRange
(common)

positionField

const val positionField: String
(common)

postCodeField

const val postCodeField: String
(common)

preCheckoutQueryIdField

const val preCheckoutQueryIdField: String
(common)

priceDependOnShipAddressField

const val priceDependOnShipAddressField: String
(common)

pricesField

const val pricesField: String
(common)

providerDataField

const val providerDataField: String
(common)

providerPaymentChargeIdField

const val providerPaymentChargeIdField: String
(common)

providerTokenField

const val providerTokenField: String
(common)

queryField

const val queryField: String
(common)

questionField

const val questionField: String
(common)

quizPollExplanationLimit

val quizPollExplanationLimit: IntRange
(common)

quizPollType

const val quizPollType: String
(common)

regularPollType

const val regularPollType: String
(common)

replyMarkupField

const val replyMarkupField: String
(common)

replyToMessageIdField

const val replyToMessageIdField: String
(common)

requestContactField

const val requestContactField: String
(common)

requestLocationField

const val requestLocationField: String
(common)

requestPollField

const val requestPollField: String
(common)

requestWriteAccessField

const val requestWriteAccessField: String
(common)

requireEmailField

const val requireEmailField: String
(common)

requireNameField

const val requireNameField: String
(common)

requirePhoneNumberField

const val requirePhoneNumberField: String
(common)

requireShippingAddressField

const val requireShippingAddressField: String
(common)

resultIdField

const val resultIdField: String
(common)

resultsField

const val resultsField: String
(common)

scaleField

const val scaleField: String
(common)

scoreField

const val scoreField: String
(common)

secondStreetLineField

const val secondStreetLineField: String
(common)

shippingAddressField

const val shippingAddressField: String
(common)

shippingOptionIdField

const val shippingOptionIdField: String
(common)

shippingOptionsField

const val shippingOptionsField: String
(common)

shippingQueryIdField

const val shippingQueryIdField: String
(common)

shouldSendEmailToProviderField

const val shouldSendEmailToProviderField: String
(common)

shouldSendPhoneNumberToProviderField

const val shouldSendPhoneNumberToProviderField: String
(common)

showAlertField

const val showAlertField: String
(common)

slowModeDelayField

const val slowModeDelayField: String
(common)

smallFileIdField

const val smallFileIdField: String
(common)

smallFileUniqueIdField

const val smallFileUniqueIdField: String
(common)

startParameterField

const val startParameterField: String
(common)

stateField

const val stateField: String
(common)

stickerField

const val stickerField: String
(common)

stickerFileIdField

const val stickerFileIdField: String
(common)

stickerSetNameField

const val stickerSetNameField: String
(common)

stickerSetNameFullField

const val stickerSetNameFullField: String
(common)

stickersField

const val stickersField: String
(common)

supportInlineQueriesField

const val supportInlineQueriesField: String
(common)

supportStreamingField

const val supportStreamingField: String
(common)

switchInlineQueryCurrentChatField

const val switchInlineQueryCurrentChatField: String
(common)

switchInlineQueryField

const val switchInlineQueryField: String
(common)

switchPmParameterField

const val switchPmParameterField: String
(common)

switchPmTextField

const val switchPmTextField: String
(common)

telegramInlineModeGifPermittedMimeTypes

val telegramInlineModeGifPermittedMimeTypes: List<MimeType>
(common)

telegramPaymentChargeIdField

const val telegramPaymentChargeIdField: String
(common)

textEntitiesField

const val textEntitiesField: String
(common)

textField

const val textField: String
(common)

textLength

val textLength: IntRange
(common)

tgsStickerField

const val tgsStickerField: String
(common)

thumbField

const val thumbField: String
(common)

thumbHeightField

const val thumbHeightField: String
(common)

thumbMimeTypeField

const val thumbMimeTypeField: String
(common)

thumbUrlField

const val thumbUrlField: String
(common)

thumbWidthField

const val thumbWidthField: String
(common)

titleField

const val titleField: String
(common)

totalAmountField

const val totalAmountField: String
(common)

totalVoterCountField

const val totalVoterCountField: String
(common)

typeField

const val typeField: String
(common)

untilDateField

const val untilDateField: String
(common)

UPDATE_CALLBACK_QUERY

const val UPDATE_CALLBACK_QUERY: String
(common)

UPDATE_CHANNEL_POST

const val UPDATE_CHANNEL_POST: String
(common)

UPDATE_CHOSEN_INLINE_RESULT

const val UPDATE_CHOSEN_INLINE_RESULT: String
(common)

UPDATE_EDITED_CHANNEL_POST

const val UPDATE_EDITED_CHANNEL_POST: String
(common)

UPDATE_EDITED_MESSAGE

const val UPDATE_EDITED_MESSAGE: String
(common)

UPDATE_INLINE_QUERY

const val UPDATE_INLINE_QUERY: String
(common)

UPDATE_MESSAGE

const val UPDATE_MESSAGE: String
(common)

UPDATE_POLL

const val UPDATE_POLL: String
(common)

UPDATE_POLL_ANSWER

const val UPDATE_POLL_ANSWER: String
(common)

UPDATE_PRE_CHECKOUT_QUERY

const val UPDATE_PRE_CHECKOUT_QUERY: String
(common)

UPDATE_SHIPPING_QUERY

const val UPDATE_SHIPPING_QUERY: String
(common)

updateIdField

const val updateIdField: String
(common)

urlField

const val urlField: String
(common)

userField

const val userField: String
(common)

userIdField

const val userIdField: String
(common)

usernameField

const val usernameField: String
(common)

userProfilePhotosRequestLimit

val userProfilePhotosRequestLimit: IntRange
(common)

valueField

const val valueField: String
(common)

vcardField

const val vcardField: String
(common)

videoDurationField

const val videoDurationField: String
(common)

videoField

const val videoField: String
(common)

videoFileIdField

const val videoFileIdField: String
(common)

videoHeightField

const val videoHeightField: String
(common)

videoNoteField

const val videoNoteField: String
(common)

videoUrlField

const val videoUrlField: String
(common)

videoWidthField

const val videoWidthField: String
(common)

voiceDurationField

const val voiceDurationField: String
(common)

voiceField

const val voiceField: String
(common)

voiceFileIdField

const val voiceFileIdField: String
(common)

voiceUrlField

const val voiceUrlField: String
(common)

votesCountField

const val votesCountField: String
(common)

widthField

const val widthField: String
(common)

xShiftField

const val xShiftField: String
(common)

yShiftField

const val yShiftField: String

Functions

(jvm)

javaLocale

fun CommonUser.javaLocale(): Locale?