Package dev.inmo.tgbotapi.types

Types

AuthorSignature

typealias AuthorSignature = ForwardSignature

Bot

sealed class Bot : User

BotCommand

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

CallbackQueryIdentifier

typealias CallbackQueryIdentifier = String

ChatAdministratorRightsImpl

data class ChatAdministratorRightsImpl(canChangeInfo: Boolean, canPostMessages: Boolean, canEditMessages: Boolean, canRemoveMessages: Boolean, canInviteUsers: Boolean, canRestrictMembers: Boolean, canPinMessages: Boolean, canPromoteMembers: Boolean, canManageVideoChats: Boolean, canManageChat: Boolean, isAnonymous: Boolean) : ChatAdministratorRights

ChatId

data class ChatId(chatId: Identifier) : ChatIdentifier

Also used as User Identifier

ChatIdentifier

sealed class ChatIdentifier

ChatIdentifierSerializer

object ChatIdentifierSerializer : KSerializer<ChatIdentifier>

ChatInviteLink

interface ChatInviteLink : WithUser

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

ChatInviteLinkSerializer

object ChatInviteLinkSerializer : KSerializer<ChatInviteLink>

ChatInviteLinkUnlimited

data class ChatInviteLinkUnlimited(inviteLink: String, creator: User, name: String?, isRevoked: Boolean, expireDate: TelegramDate?) : SecondaryChatInviteLink

Represent SecondaryChatInviteLink which have no any restrictions like ChatInviteLinkWithJoinRequest or ChatInviteLinkWithLimitedMembers

ChatInviteLinkWithJoinRequest

data class ChatInviteLinkWithJoinRequest(inviteLink: String, creator: User, name: String?, leftToReview: Int, isRevoked: Boolean, expireDate: TelegramDate?) : SecondaryChatInviteLink

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

ChatInviteLinkWithLimitedMembers

data class ChatInviteLinkWithLimitedMembers(inviteLink: String, creator: User, name: String?, membersLimit: MembersLimit, isRevoked: Boolean, expireDate: TelegramDate?) : SecondaryChatInviteLink

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

ChatJoinRequest

data class ChatJoinRequest(chat: PublicChat, from: User, date: TelegramDate, inviteLink: ChatInviteLink, bio: String?) : FromUser

Represent a ChatJoinRequest

ChatLocation

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

Represents a location to which a chat is connected.

ChatMemberUpdated

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

ChatPhoto

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

CommonBot

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

CommonUser

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

Contact

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

Degrees

typealias Degrees = Int

DiceResult

typealias DiceResult = Int

ExtendedBot

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

ExtendedUser

typealias ExtendedUser = ExtendedPrivateChatImpl

FileUniqueId

typealias FileUniqueId = String

ForwardSenderName

typealias ForwardSenderName = String

ForwardSignature

typealias ForwardSignature = String

FoursquareId

typealias FoursquareId = String

FoursquareType

typealias FoursquareType = String

GooglePlaceId

typealias GooglePlaceId = String

GooglePlaceType

typealias GooglePlaceType = String

Identifier

typealias Identifier = Long

InlineMessageIdentifier

typealias InlineMessageIdentifier = String

InlineQueryIdentifier

typealias InlineQueryIdentifier = String

InvoicePayload

typealias InvoicePayload = String

LoginURL

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

LongSeconds

typealias LongSeconds = Long

MediaGroupIdentifier

typealias MediaGroupIdentifier = String

MembersLimit

typealias MembersLimit = Int

MenuButton

interface MenuButton

MenuButtonSerializer

object MenuButtonSerializer : KSerializer<MenuButton>

MessageIdentifier

typealias MessageIdentifier = Long

MessageIdSerializer

object MessageIdSerializer : KSerializer<MessageIdentifier>

Meters

typealias Meters = Float

MigrateChatId

data class MigrateChatId(newChatId: ChatId) : RequestError

MilliSeconds

typealias MilliSeconds = Long

PaymentQueryIdentifier

typealias PaymentQueryIdentifier = String

PollIdentifier

typealias PollIdentifier = String

PreCheckoutQueryId

typealias PreCheckoutQueryId = String

PrimaryInviteLink

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

Primary invite link in the chat for this bot

RequestError

sealed class RequestError

Response

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

ResponseParametersRaw

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

RetryAfterError

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

SecondaryChatInviteLink

interface SecondaryChatInviteLink : ChatInviteLink

Base interface for all ChatInviteLinks which are NOT PrimaryInviteLink

Seconds

typealias Seconds = Int

ShippingOptionIdentifier

typealias ShippingOptionIdentifier = String

ShippingQueryIdentifier

typealias ShippingQueryIdentifier = String

StartParameter

typealias StartParameter = String

StickerSetName

typealias StickerSetName = String

TelegramDate

data class TelegramDate(date: Long)

TelegramDateSerializer

object TelegramDateSerializer : KSerializer<TelegramDate>

UnixTimeStamp

typealias UnixTimeStamp = LongSeconds

UpdateIdentifier

typealias UpdateIdentifier = Long

User

sealed class User : PrivateChat

UserId

typealias UserId = ChatId

Username

data class Username(username: String) : ChatIdentifier

UserProfilePhotos

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

UserProfilePhotosPhotosSerializer

object UserProfilePhotosPhotosSerializer : KSerializer<List<Photo>>

UserSerializer

object UserSerializer : KSerializer<User>

WebAppQueryId

typealias WebAppQueryId = String

WebhookInfo

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