data class ChatInviteLinkUnlimited(val inviteLink: String, val creator: User, val name: String? = null, val isRevoked: Boolean = false, expireDate: TelegramDate? = null, val subscriptionPeriod: TimeSpan? = null, val subscriptionPrice: UInt? = null) : SecondaryChatInviteLink

Represent SecondaryChatInviteLink which have no any restrictions like ChatInviteLinkWithJoinRequest or ChatInviteLinkWithLimitedMembers

ChatInviteLinkWithJoinRequest

@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, val subscriptionPeriod: TimeSpan? = null, val subscriptionPrice: UInt? = null) : SecondaryChatInviteLink

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

ChatInviteLinkWithLimitedMembers

@Serializable

data class ChatInviteLinkWithLimitedMembers(val inviteLink: String, val creator: User, val name: String? = null, val membersLimit: MembersLimit, val isRevoked: Boolean = false, expireDate: TelegramDate? = null, val subscriptionPeriod: TimeSpan? = null, val subscriptionPrice: UInt? = null) : SecondaryChatInviteLink

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

ChatJoinRequestQueryId

@Serializable

@JvmInline

value class ChatJoinRequestQueryId(val string: String)

Identifier of a join request query.

ChatLocation

@Serializable

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

Represents a location to which a chat is connected.

ChatPhoto

@Serializable

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

Contact

@Serializable

data class Contact(val phoneNumber: String, val firstName: String, val lastName: String? = null, val userId: UserId? = null, val vcard: String? = null) : CommonContactData, ReplyInfo.External.ContentVariant

CustomEmojiId

@Serializable

@JvmInline

value class CustomEmojiId(val string: String)

DateTimeFormatPart

@Serializable

sealed interface DateTimeFormatPart

Common interface for parts of date time format. Used for dev.inmo.tgbotapi.types.message.textsources.DateTimeTextSource

Degrees

typealias Degrees = Int

DiceResult

typealias DiceResult = Int

DirectMessagesConfigurationChanged

@Serializable(with = DirectMessagesConfigurationChanged.Companion::class)

sealed interface DirectMessagesConfigurationChanged : ChannelEvent

DirectMessageThreadId

@Serializable

@JvmInline

value class DirectMessageThreadId(val long: Long)

DoubleSeconds

typealias DoubleSeconds = Double

DraftId

@Serializable

@JvmInline

value class DraftId(val long: Long)

EffectId

@Serializable

@JvmInline

value class EffectId(val string: String)

EphemeralChatId

@Serializable(with = ChatIdentifierSerializer::class)

@JvmInline

value class EphemeralChatId(val chatIdWithReceiverUserAndEphemeralMessageId: Triple<RawChatId, UserId, EphemeralMessageId?>) : IdChatIdentifier

Chat id of group/supergroup additionally carrying ephemeral receiverUser (and optional ephemeralMessageId); used to default receiverUserId/ephemeralMessageId params of ephemeral-related requests

EphemeralMessageId

@Serializable

@JvmInline

value class EphemeralMessageId(val long: Long)

ForumTopic

@Serializable

data class ForumTopic(val messageThreadId: MessageThreadId, val name: String, val color: RGBColor, val iconEmojiId: CustomEmojiId? = null, val isNameImplicit: Boolean = false)

ForwardSenderName

typealias ForwardSenderName = String

ForwardSignature

typealias ForwardSignature = String

FoursquareId

typealias FoursquareId = String

FoursquareType

typealias FoursquareType = String

FullChatIdentifierSerializer

object FullChatIdentifierSerializer : KSerializer<ChatIdentifier>

GiftId

@Serializable

@JvmInline

value class GiftId(val string: String)

GooglePlaceId

typealias GooglePlaceId = String

GooglePlaceType

typealias GooglePlaceType = String

GuestQueryId

@Serializable

@JvmInline

value class GuestQueryId(val string: String)

IdChatIdentifier

@Serializable(with = ChatIdentifierSerializer::class)

sealed interface IdChatIdentifier : ChatIdentifier

Also used as User Identifier

InlineMessageId

@Serializable

@JvmInline

value class InlineMessageId(val string: String)

InlineQueryId

@Serializable

@JvmInline

value class InlineQueryId(val string: String)

InvoicePayload

typealias InvoicePayload = String

Level

@Serializable

@JvmInline

value class Level(val int: Int)

Link

@Serializable

data class Link(val url: String) : PollMedia

Represents an HTTP link.

LinkPreviewOptions

@Serializable(with = LinkPreviewOptions.Companion::class)

sealed interface LinkPreviewOptions

LoginURL

@Serializable

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

LongSeconds

typealias LongSeconds = Long

MediaGroupId

@Serializable

@JvmInline

value class MediaGroupId(val string: String)

MembersLimit

typealias MembersLimit = Int

MenuButton

@Serializable(with = MenuButtonSerializer::class)

sealed interface MenuButton

MenuButtonSerializer

object MenuButtonSerializer : KSerializer<MenuButton>

MessageId

@Serializable

@JvmInline

value class MessageId(val long: Long)

MessageIdSerializer

object MessageIdSerializer : KSerializer<MessageId>

MessageThreadId

@Serializable

@JvmInline

value class MessageThreadId(val long: Long)

Meters

typealias Meters = Float

MigrateChatId

data class MigrateChatId(val newChatId: IdChatIdentifier) : RequestError

MilliSeconds

typealias MilliSeconds = Long

OwnedGifts

@Serializable

data class OwnedGifts<GiftType : OwnedGift>(val totalCount: Int, val gifts: List<GiftType>, val nextOffset: String? = null)

PaidMediaPayload

@Serializable

@JvmInline

value class PaidMediaPayload(val string: String)

PaidMessagePriceChanged

@Serializable

data class PaidMessagePriceChanged(val cost: Int) : CommonEvent

PaymentQueryIdentifier

typealias PaymentQueryIdentifier = String

PollId

@Serializable

@JvmInline

value class PollId(val string: String)

PreCheckoutQueryId

@Serializable

@JvmInline

value class PreCheckoutQueryId(val string: String)

PreparedMessageId

@Serializable

@JvmInline

value class PreparedMessageId(val string: String)

PrimaryInviteLink

@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

Rating

@Serializable

@JvmInline

value class Rating(val int: Int)

RawChatId

@Serializable

@JvmInline

value class RawChatId(val long: Long)

ReplyInfo

sealed interface ReplyInfo

ReplyParameters

@Serializable(with = ReplyParameters.Serializer::class)

sealed interface ReplyParameters

RequestError

sealed class RequestError

Response

@Serializable

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

ResponseParametersRaw

@Serializable

data class ResponseParametersRaw(migrateToChatId: IdChatIdentifier? = null, retryAfter: Seconds? = null)

RetryAfterError

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

SecondaryChatInviteLink

@Serializable(with = ChatInviteLinkSerializer::class)

sealed interface SecondaryChatInviteLink : ChatInviteLink, SubscriptionInfo

Base interface for all ChatInviteLinks which are NOT PrimaryInviteLink

Seconds

typealias Seconds = Int

ShippingOptionId

@Serializable

@JvmInline

value class ShippingOptionId(val string: String)

ShippingQueryId

@Serializable

@JvmInline

value class ShippingQueryId(val string: String)

StartParameter

typealias StartParameter = String

StarTransactionId

@Serializable

@JvmInline

value class StarTransactionId(val string: String)

StickerFormat

@Serializable(with = StickerFormat.Serializer::class)

sealed interface StickerFormat

StickerSetName

@Serializable

@JvmInline

value class StickerSetName(val string: String)

StickerType

@Serializable(with = StickerType.Serializer::class)

sealed interface StickerType

StoryId

@Serializable

@JvmInline

value class StoryId(val long: Long)

TelegramDate

@Serializable(with = TelegramDateSerializer::class)

data class TelegramDate(date: Long)

TelegramDateSerializer

object TelegramDateSerializer : KSerializer<TelegramDate>

TextQuote

@Serializable

data class TextQuote : TextedInput

TgDateTimeFormatBuilder

class TgDateTimeFormatBuilder

Builder for date time format string. Use buildDateTimeFormat for convenience

TgFileUniqueId

@Serializable

@JvmInline

value class TgFileUniqueId(val string: String)

UnixTimeStamp

typealias UnixTimeStamp = LongSeconds

UpdateId

@Serializable

@JvmInline

value class UpdateId(val long: Long) : Comparable<UpdateId>

UserId

typealias UserId = IdChatIdentifier

Username

@Serializable(with = ChatIdentifierSerializer::class)

@JvmInline

value class Username(val full: String) : ChatIdentifier

A value class representing a username that always starts with the "@" symbol.

UserProfileAudios

@Serializable

data class UserProfileAudios(val totalCount: Int, val audios: List<AudioFile>)

UserProfilePhotos

@Serializable

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

UserProfilePhotosPhotosSerializer

object UserProfilePhotosPhotosSerializer : KSerializer<List<PhotoFile>>

UserTag

@Serializable

@JvmInline

value class UserTag(val string: String)

WebAppQueryId

@Serializable

@JvmInline

value class WebAppQueryId(val string: String)

WebhookInfo

@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)

Package-level declarations

Types

Properties

Functions