Serialized Form

Package io.github.natanimn.telebof.exceptions

Exception Class io.github.natanimn.telebof.exceptions.BadRequest

class BadRequest extends TelegramApiException implements Serializable

Exception Class io.github.natanimn.telebof.exceptions.ConnectionError

class ConnectionError extends RuntimeException implements Serializable

Exception Class io.github.natanimn.telebof.exceptions.FloodError

class FloodError extends TelegramApiException implements Serializable

Exception Class io.github.natanimn.telebof.exceptions.Forbidden

class Forbidden extends TelegramApiException implements Serializable

Exception Class io.github.natanimn.telebof.exceptions.TelegramApiException

class TelegramApiException extends RuntimeException implements Serializable

Serialized Fields

description

String description

error_code

int error_code

name

String name

ok

boolean ok

parameters

ResponseParameters parameters

Exception Class io.github.natanimn.telebof.exceptions.TelegramError

class TelegramError extends RuntimeException implements Serializable

Package io.github.natanimn.telebof.types.bot

Class io.github.natanimn.telebof.types.bot.BotCommand

class BotCommand extends Object implements Serializable

Serialized Fields

command

String command

Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.

description

String description

Description of the command; 1-256 characters.

Class io.github.natanimn.telebof.types.bot.BotCommandScope

class BotCommandScope extends Object implements Serializable

Serialized Fields

type

String type

Scope type

Class io.github.natanimn.telebof.types.bot.BotCommandScopeAllChatAdministrators

class BotCommandScopeAllChatAdministrators extends BotCommandScope implements Serializable

Class io.github.natanimn.telebof.types.bot.BotCommandScopeAllGroupChats

class BotCommandScopeAllGroupChats extends BotCommandScope implements Serializable

Class io.github.natanimn.telebof.types.bot.BotCommandScopeAllPrivateChats

class BotCommandScopeAllPrivateChats extends BotCommandScope implements Serializable

Class io.github.natanimn.telebof.types.bot.BotCommandScopeChat

class BotCommandScopeChat extends BotCommandScope implements Serializable

Serialized Fields

chat_id

Object chat_id

Class io.github.natanimn.telebof.types.bot.BotCommandScopeChatAdministrators

class BotCommandScopeChatAdministrators extends BotCommandScope implements Serializable

Serialized Fields

chat_id

Object chat_id

Class io.github.natanimn.telebof.types.bot.BotCommandScopeChatMember

class BotCommandScopeChatMember extends BotCommandScope implements Serializable

Serialized Fields

chat_id

Object chat_id

Class io.github.natanimn.telebof.types.bot.BotCommandScopeDefault

class BotCommandScopeDefault extends BotCommandScope implements Serializable

Package io.github.natanimn.telebof.types.chat_and_user

Class io.github.natanimn.telebof.types.chat_and_user.ChatAdministratorRights

class ChatAdministratorRights extends Object implements Serializable

Serialized Fields

can_change_info

Boolean can_change_info

True, if the user is allowed to change the chat title, photo and other settings

can_delete_messages

Boolean can_delete_messages

True, if the administrator can delete messages of other user

can_delete_stories

Boolean can_delete_stories

True, if the administrator can delete stories posted by other users

can_edit_messages

Boolean can_edit_messages

True, if the administrator can edit messages of other users and can pin messages; for channels only

can_edit_stories

Boolean can_edit_stories

True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive

can_invite_users

Boolean can_invite_users

True, if the user is allowed to invite new users to the chat

can_manage_chat

Boolean can_manage_chat

True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.

can_manage_topics

Boolean can_manage_topics

True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only

can_manage_video_chats

Boolean can_manage_video_chats

True, if the administrator can manage video chats

can_pin_messages

Boolean can_pin_messages

True, if the user is allowed to pin messages; for groups and supergroups only

can_post_messages

Boolean can_post_messages

True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only

can_post_stories

Boolean can_post_stories

True, if the administrator can post stories to the chat

can_promote_members

Boolean can_promote_members

True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)

can_restrict_members

Boolean can_restrict_members

True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics

is_anonymous

Boolean is_anonymous

True, if the user's presence in the chat is hidden

Class io.github.natanimn.telebof.types.chat_and_user.ChatPermissions

class ChatPermissions extends Object implements Serializable

Serialized Fields

can_add_web_page_previews

Boolean can_add_web_page_previews

Optional. True, if the user is allowed to add web page previews to their messages

can_change_info

Boolean can_change_info

Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups

can_invite_users

Boolean can_invite_users

Optional. True, if the user is allowed to invite new users to the chat

can_manage_topics

Boolean can_manage_topics

Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages

can_pin_messages

Boolean can_pin_messages

Optional. True, if the user is allowed to pin messages. Ignored in public supergroups

can_send_audios

Boolean can_send_audios

Optional. True, if the user is allowed to send audios

can_send_documents

Boolean can_send_documents

Optional. True, if the user is allowed to send documents

can_send_messages

Boolean can_send_messages

Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues

can_send_other_messages

Boolean can_send_other_messages

Optional. True, if the user is allowed to send animations, games, stickers and use inline bots

can_send_photos

Boolean can_send_photos

Optional. True, if the user is allowed to send photos

can_send_polls

Boolean can_send_polls

Optional. True, if the user is allowed to send polls and checklists

can_send_video_notes

Boolean can_send_video_notes

Optional. True, if the user is allowed to send video notes

can_send_videos

Boolean can_send_videos

Optional. True, if the user is allowed to send videos

can_send_voice_notes

Boolean can_send_voice_notes

Optional. True, if the user is allowed to send voice notes

Package io.github.natanimn.telebof.types.gift_and_giveaway

Class io.github.natanimn.telebof.types.gift_and_giveaway.AcceptedGiftTypes

class AcceptedGiftTypes extends Object implements Serializable

Serialized Fields

limited_gifts

Boolean limited_gifts

True, if limited regular gifts are accepted

premium_subscription

Boolean premium_subscription

True, if a Telegram Premium subscription is accepted

unique_gifts

Boolean unique_gifts

True, if unique gifts or gifts that can be upgraded to unique for free are accepted

unlimited_gifts

Boolean unlimited_gifts

True, if unlimited regular gifts are accepted

Class io.github.natanimn.telebof.types.gift_and_giveaway.UniqueGiftBackdropColors

class UniqueGiftBackdropColors extends Object implements Serializable

Serialized Fields

center_color

Integer center_color

The color in the center of the backdrop in RGB format

edge_color

Integer edge_color

The color on the edges of the backdrop in RGB format

symbol_color

Integer symbol_color

The color to be applied to the symbol in RGB format

text_color

Integer text_color

The color for the text on the backdrop in RGB format

Package io.github.natanimn.telebof.types.inline

Class io.github.natanimn.telebof.types.inline.InlineQueryResultArticle

class InlineQueryResultArticle extends Object implements Serializable

Serialized Fields

description

String description

id

String id

input_message_content

InputTextMessageContent input_message_content

reply_markup

InlineKeyboardMarkup reply_markup

thumbnail_height

Integer thumbnail_height

thumbnail_url

String thumbnail_url

thumbnail_width

Integer thumbnail_width

title

String title

type

String type

url

String url

Class io.github.natanimn.telebof.types.inline.InlineQueryResultAudio

class InlineQueryResultAudio extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultAudio> implements Serializable

Serialized Fields

audio_duration

Integer audio_duration

audio_url

String audio_url

id

String id

performer

String performer

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedAudio

class InlineQueryResultCachedAudio extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedAudio> implements Serializable

Serialized Fields

audio_file_id

String audio_file_id

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedDocument

class InlineQueryResultCachedDocument extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedDocument> implements Serializable

Serialized Fields

description

String description

document_file_id

String document_file_id

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedGif

class InlineQueryResultCachedGif extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedGif> implements Serializable

Serialized Fields

gif_file_id

String gif_file_id

show_caption_above_media

Boolean show_caption_above_media

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedMpeg4Gif

class InlineQueryResultCachedMpeg4Gif extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedMpeg4Gif> implements Serializable

Serialized Fields

mpeg4_file_id

String mpeg4_file_id

show_caption_above_media

Boolean show_caption_above_media

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedPhoto

class InlineQueryResultCachedPhoto extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedPhoto> implements Serializable

Serialized Fields

description

String description

photo_file_id

String photo_file_id

show_caption_above_media

Boolean show_caption_above_media

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedSticker

class InlineQueryResultCachedSticker extends Object implements Serializable

Serialized Fields

id

String id

input_message_content

InputTextMessageContent input_message_content

reply_markup

InlineKeyboardMarkup reply_markup

sticker_file_id

String sticker_file_id

type

String type

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedVideo

class InlineQueryResultCachedVideo extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedVideo> implements Serializable

Serialized Fields

description

String description

show_caption_above_media

Boolean show_caption_above_media

title

String title

video_file_id

String video_file_id

Class io.github.natanimn.telebof.types.inline.InlineQueryResultCachedVoice

class InlineQueryResultCachedVoice extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultCachedVoice> implements Serializable

Serialized Fields

title

String title

voice_file_id

String voice_file_id

Class io.github.natanimn.telebof.types.inline.InlineQueryResultContact

class InlineQueryResultContact extends Object implements Serializable

Serialized Fields

first_name

String first_name

id

String id

input_message_content

InputTextMessageContent input_message_content

last_name

String last_name

phone_number

String phone_number

reply_markup

InlineKeyboardMarkup reply_markup

thumbnail_height

Integer thumbnail_height

thumbnail_url

String thumbnail_url

thumbnail_width

Integer thumbnail_width

type

String type

vcard

String vcard

Class io.github.natanimn.telebof.types.inline.InlineQueryResultDocument

class InlineQueryResultDocument extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultDocument> implements Serializable

Serialized Fields

description

String description

document

String document

document_url

String document_url

mime_type

MimeType mime_type

thumbnail_height

Integer thumbnail_height

thumbnail_url

String thumbnail_url

thumbnail_width

Integer thumbnail_width

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultGame

class InlineQueryResultGame extends Object implements Serializable

Serialized Fields

game_short_name

String game_short_name

id

String id

reply_markup

InlineKeyboardMarkup reply_markup

type

String type

Class io.github.natanimn.telebof.types.inline.InlineQueryResultGif

class InlineQueryResultGif extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultGif> implements Serializable

Serialized Fields

gif_duration

Integer gif_duration

gif_height

Integer gif_height

gif_url

String gif_url

gif_width

Integer gif_width

show_caption_above_media

Boolean show_caption_above_media

thumbnail_mime_type

String thumbnail_mime_type

thumbnail_url

String thumbnail_url

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultLocation

class InlineQueryResultLocation extends Object implements Serializable

Serialized Fields

heading

Integer heading

horizontal_accuracy

Float horizontal_accuracy

id

String id

input_message_content

InputTextMessageContent input_message_content

latitude

Double latitude

live_period

Integer live_period

location

String location

longitude

Double longitude

proximity_alert_radius

Integer proximity_alert_radius

reply_markup

InlineKeyboardMarkup reply_markup

thumbnail_height

Integer thumbnail_height

thumbnail_url

String thumbnail_url

thumbnail_width

Integer thumbnail_width

title

String title

type

String type

Class io.github.natanimn.telebof.types.inline.InlineQueryResultMpeg4Gif

class InlineQueryResultMpeg4Gif extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultMpeg4Gif> implements Serializable

Serialized Fields

mpeg4_duration

Integer mpeg4_duration

mpeg4_height

Integer mpeg4_height

mpeg4_url

String mpeg4_url

mpeg4_width

Integer mpeg4_width

show_caption_above_media

Boolean show_caption_above_media

thumbnail_mime_type

String thumbnail_mime_type

thumbnail_url

String thumbnail_url

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultPhoto

class InlineQueryResultPhoto extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultPhoto> implements Serializable

Serialized Fields

description

String description

photo_height

Integer photo_height

photo_url

String photo_url

photo_width

Integer photo_width

show_caption_above_media

Boolean show_caption_above_media

thumbnail_url

String thumbnail_url

title

String title

Class io.github.natanimn.telebof.types.inline.InlineQueryResultsButton

class InlineQueryResultsButton extends Object implements Serializable

Serialized Fields

start_parameter

String start_parameter

text

String text

web_app_info

WebAppInfo web_app_info

Class io.github.natanimn.telebof.types.inline.InlineQueryResultVenue

class InlineQueryResultVenue extends Object implements Serializable

Serialized Fields

address

String address

foursquare_id

String foursquare_id

foursquare_type

String foursquare_type

google_place_id

String google_place_id

google_place_type

String google_place_type

horizontal_accuracy

Float horizontal_accuracy

id

String id

input_message_content

InputTextMessageContent input_message_content

latitude

Double latitude

longitude

Double longitude

reply_markup

InlineKeyboardMarkup reply_markup

thumbnail_height

Integer thumbnail_height

thumbnail_url

String thumbnail_url

thumbnail_width

Integer thumbnail_width

title

String title

type

String type

Class io.github.natanimn.telebof.types.inline.InlineQueryResultVideo

class InlineQueryResultVideo extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultVideo> implements Serializable

Serialized Fields

description

String description

mime_type

String mime_type

show_caption_above_media

Boolean show_caption_above_media

thumbnail_url

String thumbnail_url

title

String title

video_duration

Integer video_duration

video_height

Integer video_height

video_url

String video_url

video_width

Integer video_width

Class io.github.natanimn.telebof.types.inline.InlineQueryResultVoice

class InlineQueryResultVoice extends io.github.natanimn.telebof.types.inline.InlineQueryMediaResult<InlineQueryResultVoice> implements Serializable

Serialized Fields

title

String title

voice_duration

Integer voice_duration

voice_url

String voice_url

Class io.github.natanimn.telebof.types.inline.InputContactMessageContent

class InputContactMessageContent extends Object implements Serializable

Serialized Fields

first_name

String first_name

last_name

String last_name

phone_number

String phone_number

vcard

String vcard

Package io.github.natanimn.telebof.types.input

Class io.github.natanimn.telebof.types.input.InputChecklist

class InputChecklist extends Object implements Serializable

Serialized Fields

others_can_add_tasks

Boolean others_can_add_tasks

others_can_mark_tasks_as_done

Boolean others_can_mark_tasks_as_done

parse_mode

ParseMode parse_mode

tasks

InputChecklistTask[] tasks

title

String title

title_entities

MessageEntity[] title_entities

Class io.github.natanimn.telebof.types.input.InputChecklistTask

class InputChecklistTask extends Object implements Serializable

Serialized Fields

id

Integer id

parse_mode

ParseMode parse_mode

text

String text

text_entities

MessageEntity[] text_entities

Class io.github.natanimn.telebof.types.input.InputInvoiceMessageContent

class InputInvoiceMessageContent extends Object implements Serializable

Serialized Fields

currency

String currency

description

String description

is_flexible

Boolean is_flexible

max_tip_amount

Integer max_tip_amount

need_email

Boolean need_email

need_name

Boolean need_name

need_phone_number

Boolean need_phone_number

need_shipping_address

Boolean need_shipping_address

payload

String payload

photo_height

Integer photo_height

photo_size

Integer photo_size

photo_url

String photo_url

photo_width

Integer photo_width

prices

List<LabeledPrice> prices

provider_data

String provider_data

provider_token

String provider_token

send_email_to_provider

Boolean send_email_to_provider

send_phone_number_to_provider

Boolean send_phone_number_to_provider

suggested_tip_amount

List<Integer> suggested_tip_amount

title

String title

Class io.github.natanimn.telebof.types.input.InputLocationMessageContent

class InputLocationMessageContent extends Object implements Serializable

Serialized Fields

heading

Integer heading

horizontal_accuracy

double horizontal_accuracy

latitude

double latitude

live_period

Integer live_period

longitude

double longitude

proximity_alert_radius

Integer proximity_alert_radius

Class io.github.natanimn.telebof.types.input.InputMediaAnimation

class InputMediaAnimation extends InputMediaBuilder<InputMediaAnimation> implements Serializable

Serialized Fields

duration

Integer duration

has_spoiler

Boolean has_spoiler

height

Integer height

thumbnail

String thumbnail

width

Integer width

Class io.github.natanimn.telebof.types.input.InputMediaAudio

class InputMediaAudio extends InputMediaBuilder<InputMediaAudio> implements Serializable

Serialized Fields

duration

Integer duration

has_spoiler

Boolean has_spoiler

performer

String performer

thumbnail

String thumbnail

title

String title

Class io.github.natanimn.telebof.types.input.InputMediaBuilder

class InputMediaBuilder extends Object implements Serializable

Serialized Fields

caption

String caption

caption_entities

List<MessageEntity> caption_entities

media

String media

parse_mode

ParseMode parse_mode

thisT

T thisT

type

String type

Class io.github.natanimn.telebof.types.input.InputMediaDocument

class InputMediaDocument extends InputMediaBuilder<InputMediaDocument> implements Serializable

Serialized Fields

disable_content_type_detection

Boolean disable_content_type_detection

thumbnail

String thumbnail

Class io.github.natanimn.telebof.types.input.InputMediaPhoto

class InputMediaPhoto extends InputMediaBuilder<InputMediaPhoto> implements Serializable

Serialized Fields

has_spoiler

Boolean has_spoiler

Class io.github.natanimn.telebof.types.input.InputMediaVideo

class InputMediaVideo extends InputMediaBuilder<InputMediaVideo> implements Serializable

Serialized Fields

cover

String cover

duration

Integer duration

has_spoiler

Boolean has_spoiler

height

Integer height

start_timestamp

Integer start_timestamp

supports_streaming

Boolean supports_streaming

thumbnail

String thumbnail

width

Integer width

Class io.github.natanimn.telebof.types.input.InputPaidMediaPhoto

class InputPaidMediaPhoto extends Object implements Serializable

Serialized Fields

media

String media

type

String type

Class io.github.natanimn.telebof.types.input.InputPaidMediaVideo

class InputPaidMediaVideo extends Object implements Serializable

Serialized Fields

cover

String cover

duration

Integer duration

height

Integer height

media

String media

start_timestamp

Integer start_timestamp

supports_streaming

Boolean supports_streaming

thumbnail

String thumbnail

type

String type

width

Integer width

Class io.github.natanimn.telebof.types.input.InputPollOption

class InputPollOption extends Object implements Serializable

Serialized Fields

text

String text

text_entities

List<MessageEntity> text_entities

text_parse_mode

ParseMode text_parse_mode

Class io.github.natanimn.telebof.types.input.InputProfilePhotoAnimated

class InputProfilePhotoAnimated extends Object implements Serializable

Serialized Fields

animation

String animation

main_frame_timestamp

Double main_frame_timestamp

type

String type

Class io.github.natanimn.telebof.types.input.InputProfilePhotoStatic

class InputProfilePhotoStatic extends Object implements Serializable

Serialized Fields

photo

String photo

type

String type

Class io.github.natanimn.telebof.types.input.InputSticker

class InputSticker extends Object implements Serializable

Serialized Fields

emoji_list

List<String> emoji_list

format

StickerFormat format

keywords

List<String> keywords

mask_position

MaskPosition mask_position

sticker

String sticker

Class io.github.natanimn.telebof.types.input.InputStoryContentPhoto

class InputStoryContentPhoto extends Object implements Serializable

Serialized Fields

photo

String photo

type

String type

Class io.github.natanimn.telebof.types.input.InputStoryContentVideo

class InputStoryContentVideo extends Object implements Serializable

Serialized Fields

cover_frame_timestamp

Double cover_frame_timestamp

duration

Double duration

is_animation

Boolean is_animation

type

String type

video

String video

Class io.github.natanimn.telebof.types.input.InputTextMessageContent

class InputTextMessageContent extends Object implements Serializable

Serialized Fields

entities

List<MessageEntity> entities

link_preview_options

LinkPreviewOptions link_preview_options

message_text

String message_text

parse_mode

ParseMode parse_mode

Class io.github.natanimn.telebof.types.input.InputVenueMessageContent

class InputVenueMessageContent extends Object implements Serializable

Serialized Fields

address

String address

foursquare_id

String foursquare_id

foursquare_type

String foursquare_type

google_place_id

String google_place_id

google_place_type

String google_place_type

latitude

double latitude

longitude

double longitude

title

String title

Package io.github.natanimn.telebof.types.keyboard

Class io.github.natanimn.telebof.types.keyboard.ForceReply

class ForceReply extends Object implements Serializable

Serialized Fields

force_reply

boolean force_reply

Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'

input_field_placeholder

String input_field_placeholder

selective

Boolean selective

Class io.github.natanimn.telebof.types.keyboard.InlineKeyboardButton

class InlineKeyboardButton extends Object implements Serializable

Serialized Fields

callback_data

String callback_data

callback_game

CallbackGame callback_game

copy_text

CopyTextButton copy_text

login_url

LoginUrl login_url

pay

Boolean pay

switch_inline_query_chosen_chat

SwitchInlineQueryChosenChat switch_inline_query_chosen_chat

switch_inline_query_current_chat

String switch_inline_query_current_chat

text

String text

url

String url

wep_app

WebAppInfo wep_app

Class io.github.natanimn.telebof.types.keyboard.InlineKeyboardMarkup

class InlineKeyboardMarkup extends Object implements Serializable

Serialized Fields

inline_keyboard

List<List<InlineKeyboardButton>> inline_keyboard

Array of button rows, each represented by an Array of InlineKeyboardButton objects

Class io.github.natanimn.telebof.types.keyboard.KeyboardButton

class KeyboardButton extends Object implements Serializable

Serialized Fields

request_chat

KeyboardButtonRequestChat request_chat

request_contact

Boolean request_contact

request_location

Boolean request_location

request_poll

KeyboardButtonPollType request_poll

request_users

KeyboardButtonRequestUsers request_users

text

String text

wep_app

WebAppInfo wep_app

Class io.github.natanimn.telebof.types.keyboard.KeyboardButtonPollType

class KeyboardButtonPollType extends Object implements Serializable

Serialized Fields

type

PollType type

Class io.github.natanimn.telebof.types.keyboard.KeyboardButtonRequestChat

class KeyboardButtonRequestChat extends Object implements Serializable

Serialized Fields

bot_administrator_rights

ChatAdministratorRights bot_administrator_rights

bot_is_member

Boolean bot_is_member

chat_has_username

Boolean chat_has_username

chat_is_channel

Boolean chat_is_channel

chat_is_created

Boolean chat_is_created

chat_is_forum

Boolean chat_is_forum

request_id

Integer request_id

request_name

Boolean request_name

request_photo

Boolean request_photo

request_title

Boolean request_title

request_username

Boolean request_username

user_administrator_rights

ChatAdministratorRights user_administrator_rights

Class io.github.natanimn.telebof.types.keyboard.KeyboardButtonRequestUsers

class KeyboardButtonRequestUsers extends Object implements Serializable

Serialized Fields

max_quantity

Byte max_quantity

request_id

Long request_id

request_name

Boolean request_name

request_photo

Boolean request_photo

request_username

Boolean request_username

user_is_bot

Boolean user_is_bot

user_is_premium

Boolean user_is_premium

Class io.github.natanimn.telebof.types.keyboard.LoginUrl

class LoginUrl extends Object implements Serializable

Serialized Fields

bot_username

String bot_username

forward_text

String forward_text

request_write_access

Boolean request_write_access

url

String url

Class io.github.natanimn.telebof.types.keyboard.MenuButton

class MenuButton extends Object implements Serializable

Serialized Fields

text

String text

type

MenuButtonType type

web_app

WebAppInfo web_app

Class io.github.natanimn.telebof.types.keyboard.ReplyKeyboardMarkup

class ReplyKeyboardMarkup extends Object implements Serializable

Serialized Fields

input_field_placeholder

String input_field_placeholder

is_persistent

Boolean is_persistent

keyboard

List<List<KeyboardButton>> keyboard

one_time_keyboard

Boolean one_time_keyboard

resize_keyboard

Boolean resize_keyboard

selective

Boolean selective

Class io.github.natanimn.telebof.types.keyboard.ReplyKeyboardRemove

class ReplyKeyboardRemove extends Object implements Serializable

Serialized Fields

remove_keyboard

boolean remove_keyboard

Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use ReplyKeyboardMarkup.oneTimeKeyboard(boolean) in ReplyKeyboardMarkup)

selective

boolean selective

Class io.github.natanimn.telebof.types.keyboard.ReplyParameters

class ReplyParameters extends Object implements Serializable

Serialized Fields

allow_sending_without_reply

Boolean allow_sending_without_reply

chat_id

Object chat_id

message_id

int message_id

quote

String quote

quote_entities

MessageEntity[] quote_entities

quote_parse_mode

ParseMode quote_parse_mode

quote_position

Integer quote_position

Package io.github.natanimn.telebof.types.media_and_service

Class io.github.natanimn.telebof.types.media_and_service.LocationAddress

class LocationAddress extends Object implements Serializable

Serialized Fields

city

String city

country_code

String country_code

state

String state

street

String street

Class io.github.natanimn.telebof.types.media_and_service.MaskPosition

class MaskPosition extends Object implements Serializable

Serialized Fields

point

String point

The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

scale

Double scale

Mask scaling coefficient. For example, 2.0 means double size.

x_shift

Double x_shift

Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.

y_shift

Double y_shift

Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.

Class io.github.natanimn.telebof.types.media_and_service.MessageEntity

class MessageEntity extends Object implements Serializable

Serialized Fields

custom_emoji_id

String custom_emoji_id

Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use BotContext.getCustomEmojiStickers(java.lang.String[]) to get full information about the sticker

language

String language

Optional. For “pre” only, the programming language of the entity text

length

Integer length

Length of the entity in UTF-16 code units

offset

Integer offset

Offset in UTF-16 code units to the start of the entity

type

EntityType type

Type of the entity.

url

String url

Optional. For “text_link” only, URL that will be opened after user taps on the text

user

User user

Optional. For “text_mention” only, the mentioned user

Class io.github.natanimn.telebof.types.media_and_service.MessageOrigin

class MessageOrigin extends Object implements Serializable

Serialized Fields

author_signature

String author_signature

For messages originally sent by an anonymous chat administrator, original message author signature, or Signature of the original post author

date

Integer date

Date the message was sent originally in Unix time

message_id

Integer message_id

Unique message identifier inside the chat

sender_chat

Chat sender_chat

Chat that sent the message originally

sender_user

User sender_user

User that sent the message originally

sender_user_name

String sender_user_name

Name of the user that sent the message originally

type

MessageOriginType type

Type of the message origin,

Class io.github.natanimn.telebof.types.media_and_service.ReactionType

class ReactionType extends Object implements Serializable

Serialized Fields

custom_emoji_id

String custom_emoji_id

Custom emoji identifier

emoji

String emoji

Reaction emoji. Currently, it can be one of "❤", "👍", "👎", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂", "🤷", "🤷‍♀", "😡"

type

TypeReaction type

Type of the reaction

Class io.github.natanimn.telebof.types.media_and_service.SwitchInlineQueryChosenChat

class SwitchInlineQueryChosenChat extends Object implements Serializable

Serialized Fields

allow_bot_chats

Boolean allow_bot_chats

Optional. True, if private chats with bots can be chosen

allow_channel_chats

Boolean allow_channel_chats

Optional. True, if channel chats can be chosen

allow_group_chats

Boolean allow_group_chats

Optional. True, if group and supergroup chats can be chosen

allow_user_chats

Boolean allow_user_chats

Optional. True, if private chats with users can be chosen

query

String query

Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted

Package io.github.natanimn.telebof.types.passport

Class io.github.natanimn.telebof.types.passport.EncryptedCredentials

class EncryptedCredentials extends Object implements Serializable

Serialized Fields

data

String data

Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication

hash

String hash

Base64-encoded data hash for data authentication

secret

String secret

Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption

Class io.github.natanimn.telebof.types.passport.EncryptedPassportElement

class EncryptedPassportElement extends Object implements Serializable

Serialized Fields

data

String data

Base64-encoded encrypted Telegram Passport element data provided by the user; available only for PassportElementType.PERSONAL_DETAILS, PassportElementType.PASSPORT, PassportElementType.DRIVER_LICENSE, PassportElementType.IDENTITY_CARD, PassportElementType.INTERNAL_PASSPORT and PassportElementType.ADDRESS types. Can be decrypted and verified using the accompanying EncryptedCredentials.

email

String email

User's verified email address; available only for PassportElementType.EMAIL type

files

List<PassportFile> files

Array of encrypted files with documents provided by the user; available only for PassportElementType.UTILITY_BILL, PassportElementType.BANK_STATEMENT, PassportElementType.RENTAL_AGREEMENT, PassportElementType.PASSPORT_REGISTRATION and PassportElementType.TEMPORARY_REGISTRATION types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

front_side

PassportFile front_side

Encrypted file with the front side of the document, provided by the user; available only for PassportElementType.PASSPORT, PassportElementType.DRIVER_LICENSE, PassportElementType.IDENTITY_CARD and PassportElementType.INTERNAL_PASSPORT. The file can be decrypted and verified using the accompanying EncryptedCredentials.

hash

String hash

Base64-encoded element hash for using in PassportElementErrorUnspecified

phone_number

String phone_number

User's verified phone number; available only for PassportElementType.PHONE_NUMBER type

reverse_side

PassportFile reverse_side

Encrypted file with the reverse side of the document, provided by the user; available only for PassportElementType.DRIVER_LICENSE and PassportElementType.IDENTITY_CARD. The file can be decrypted and verified using the accompanying EncryptedCredentials.

selfie

PassportFile selfie

Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for PassportElementType.PASSPORT, PassportElementType.DRIVER_LICENSE, PassportElementType.IDENTITY_CARD types. The file can be decrypted and verified using the accompanying EncryptedCredentials.

translation

List<PassportFile> translation

Array of encrypted files with translated versions of documents provided by the user; available if requested for PassportElementType.PASSPORT, PassportElementType.DRIVER_LICENSE, PassportElementType.IDENTITY_CARD, PassportElementType.INTERNAL_PASSPORT, PassportElementType.UTILITY_BILL, PassportElementType.BANK_STATEMENT, PassportElementType.RENTAL_AGREEMENT, PassportElementType.PASSPORT_REGISTRATION and PassportElementType.TEMPORARY_REGISTRATION types. Files can be decrypted and verified using the accompanying EncryptedCredentials.

type

PassportElementType type

Passport element type

Class io.github.natanimn.telebof.types.passport.PassportData

class PassportData extends Object implements Serializable

Serialized Fields

credentials

EncryptedCredentials credentials

Encrypted credentials required to decrypt the data

data

List<EncryptedPassportElement> data

Array with information about documents and other Telegram Passport elements that was shared with the bot

Class io.github.natanimn.telebof.types.passport.PassportElementError

class PassportElementError extends Object implements Serializable

Serialized Fields

data_hash

String data_hash

Base64-encoded data hash

element_hash

String element_hash

Base64-encoded element hash

field_name

String field_name

Name of the data field which has the error

file_hash

String file_hash

Base64-encoded file hash

file_hashes

List<String> file_hashes

List of base64-encoded file hashes

message

String message

Error message

source

PassportElementErrorSource source

Error source

type

Object type

Type of element of the user's Telegram Passport which has the issue. It is PassportElementType if PassportElementError.source is different from PassportElementErrorSource.UNSPECIFIED. Otherwise, it is String

Class io.github.natanimn.telebof.types.passport.PassportElementErrorDataField

class PassportElementErrorDataField extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorFile

class PassportElementErrorFile extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorFiles

class PassportElementErrorFiles extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorFrontSide

class PassportElementErrorFrontSide extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorReverseSide

class PassportElementErrorReverseSide extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorSelfie

class PassportElementErrorSelfie extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorTranslationFile

class PassportElementErrorTranslationFile extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorTranslationFiles

class PassportElementErrorTranslationFiles extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportElementErrorUnspecified

class PassportElementErrorUnspecified extends PassportElementError implements Serializable

Class io.github.natanimn.telebof.types.passport.PassportFile

class PassportFile extends Object implements Serializable

Serialized Fields

file_date

Integer file_date

Unix time when the file was uploaded

file_id

String file_id

Identifier for this file, which can be used to download or reuse the file

file_size

Integer file_size

File size in bytes

file_unique_id

String file_unique_id

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Package io.github.natanimn.telebof.types.payments

Class io.github.natanimn.telebof.types.payments.LabeledPrice

class LabeledPrice extends Object implements Serializable

Serialized Fields

amount

Integer amount

label

String label

Class io.github.natanimn.telebof.types.payments.ShippingAddress

class ShippingAddress extends Object implements Serializable

Serialized Fields

city

String city

City

country_code

String country_code

Two-letter ISO 3166-1 alpha-2 country code

post_code

String post_code

Address of post code

state

String state

State, if applicable

street_line1

String street_line1

First line for the address

street_line2

String street_line2

Second line for the address

Class io.github.natanimn.telebof.types.payments.ShippingOption

class ShippingOption extends Object implements Serializable

Serialized Fields

id

String id

prices

List<LabeledPrice> prices

title

String title

Class io.github.natanimn.telebof.types.payments.SuccessfulPayment

class SuccessfulPayment extends Object implements Serializable

Serialized Fields

currency

String currency

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars

invoice_payload

String invoice_payload

Bot-specified invoice payload

is_first_recurring

Boolean is_first_recurring

True, if the payment is the first payment for a subscription

is_recurring

Boolean is_recurring

True, if the payment is a recurring payment for a subscription

order_info

OrderInfo order_info

Order information provided by the user

provider_payment_charge_id

String provider_payment_charge_id

Provider payment identifier

shipping_option_id

String shipping_option_id

Identifier of the shipping option chosen by the user

subscription_expiration_date

Integer subscription_expiration_date

Expiration date of the subscription, in Unix time; for recurring payments only

telegram_payment_charge_id

String telegram_payment_charge_id

Telegram payment identifier

total_amount

Integer total_amount

Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)

Package io.github.natanimn.telebof.types.story

Class io.github.natanimn.telebof.types.story.StoryArea

class StoryArea extends Object implements Serializable

Serialized Fields

position

StoryAreaPosition position

type

StoryAreaType type

Class io.github.natanimn.telebof.types.story.StoryAreaTypeLink

class StoryAreaTypeLink extends Object implements Serializable

Serialized Fields

type

String type

url

String url

Class io.github.natanimn.telebof.types.story.StoryAreaTypeLocation

class StoryAreaTypeLocation extends Object implements Serializable

Serialized Fields

address

LocationAddress address

latitude

Double latitude

longitude

Double longitude

type

String type

Class io.github.natanimn.telebof.types.story.StoryAreaTypeSuggestedReaction

class StoryAreaTypeSuggestedReaction extends Object implements Serializable

Serialized Fields

is_dark

Boolean is_dark

is_flipped

Boolean is_flipped

reaction_type

ReactionType reaction_type

type

String type

Class io.github.natanimn.telebof.types.story.StoryAreaTypeWeather

class StoryAreaTypeWeather extends Object implements Serializable

Serialized Fields

background_color

Integer background_color

emoji

String emoji

temperature

Double temperature

type

String type

Package io.github.natanimn.telebof.types.web

Class io.github.natanimn.telebof.types.web.WebAppInfo

class WebAppInfo extends Object implements Serializable

Serialized Fields

url

String url

An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps