tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::botInfo Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::botInfo:
td::td_api::Object td::TlObject

Public Member Functions

 botInfo ()
 
 botInfo (string const &short_description_, string const &description_, object_ptr< photo > &&photo_, object_ptr< animation > &&animation_, int53 manager_bot_user_id_, object_ptr< botMenuButton > &&menu_button_, array< object_ptr< botCommand > > &&commands_, string const &privacy_policy_url_, object_ptr< chatAdministratorRights > &&default_group_administrator_rights_, object_ptr< chatAdministratorRights > &&default_channel_administrator_rights_, object_ptr< affiliateProgramInfo > &&affiliate_program_, int32 web_app_background_light_color_, int32 web_app_background_dark_color_, int32 web_app_header_light_color_, int32 web_app_header_dark_color_, object_ptr< botVerificationParameters > &&verification_parameters_, bool can_get_revenue_statistics_, bool can_manage_emoji_status_, bool has_media_previews_, object_ptr< InternalLinkType > &&edit_commands_link_, object_ptr< InternalLinkType > &&edit_description_link_, object_ptr< InternalLinkType > &&edit_description_media_link_, object_ptr< InternalLinkType > &&edit_settings_link_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string short_description_
 The text that is shown on the bot&#x27;s profile page and is sent together with the link when users share the bot.
 
string description_
 The text shown in the chat with the bot if the chat is empty.
 
object_ptr< photophoto_
 Photo shown in the chat with the bot if the chat is empty; may be null.
 
object_ptr< animationanimation_
 Animation shown in the chat with the bot if the chat is empty; may be null.
 
int53 manager_bot_user_id_
 Identifier of the bot, which manages the bot; 0 if none or unknown; for owner of the bot only.
 
object_ptr< botMenuButtonmenu_button_
 Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown.
 
array< object_ptr< botCommand > > commands_
 List of the bot commands.
 
string privacy_policy_url_
 The HTTP link to the privacy policy of the bot. If empty, then /privacy command must be used if supported by the bot. If the command isn&#x27;t supported, then https://telegram.org/privacy-tpa must be opened.
 
object_ptr< chatAdministratorRightsdefault_group_administrator_rights_
 Default administrator rights for adding the bot to basic group and supergroup chats; may be null.
 
object_ptr< chatAdministratorRightsdefault_channel_administrator_rights_
 Default administrator rights for adding the bot to channels; may be null.
 
object_ptr< affiliateProgramInfoaffiliate_program_
 Information about the affiliate program of the bot; may be null if none.
 
int32 web_app_background_light_color_
 Default light background color for bot Web Apps; -1 if not specified.
 
int32 web_app_background_dark_color_
 Default dark background color for bot Web Apps; -1 if not specified.
 
int32 web_app_header_light_color_
 Default light header color for bot Web Apps; -1 if not specified.
 
int32 web_app_header_dark_color_
 Default dark header color for bot Web Apps; -1 if not specified.
 
object_ptr< botVerificationParametersverification_parameters_
 Parameters of the verification that can be provided by the bot; may be null if none or the current user isn&#x27;t the owner of the bot.
 
bool can_get_revenue_statistics_
 True, if the bot&#x27;s revenue statistics are available to the current user.
 
bool can_manage_emoji_status_
 True, if the bot can manage emoji status of the current user.
 
bool has_media_previews_
 True, if the bot has media previews.
 
object_ptr< InternalLinkTypeedit_commands_link_
 The internal link, which can be used to edit bot commands; may be null.
 
object_ptr< InternalLinkTypeedit_description_link_
 The internal link, which can be used to edit bot description; may be null.
 
object_ptr< InternalLinkTypeedit_description_media_link_
 The internal link, which can be used to edit the photo or animation shown in the chat with the bot if the chat is empty; may be null.
 
object_ptr< InternalLinkTypeedit_settings_link_
 The internal link, which can be used to edit bot settings; may be null.
 

Static Public Attributes

static const std::int32_t ID = -586441582
 Identifier uniquely determining a type of the object.
 

Detailed Description

Contains information about a bot.

Definition at line 4599 of file td_api.h.

Constructor & Destructor Documentation

◆ botInfo() [1/2]

td::td_api::botInfo::botInfo ( )

Contains information about a bot.

◆ botInfo() [2/2]

td::td_api::botInfo::botInfo ( string const &  short_description_,
string const &  description_,
object_ptr< photo > &&  photo_,
object_ptr< animation > &&  animation_,
int53  manager_bot_user_id_,
object_ptr< botMenuButton > &&  menu_button_,
array< object_ptr< botCommand > > &&  commands_,
string const &  privacy_policy_url_,
object_ptr< chatAdministratorRights > &&  default_group_administrator_rights_,
object_ptr< chatAdministratorRights > &&  default_channel_administrator_rights_,
object_ptr< affiliateProgramInfo > &&  affiliate_program_,
int32  web_app_background_light_color_,
int32  web_app_background_dark_color_,
int32  web_app_header_light_color_,
int32  web_app_header_dark_color_,
object_ptr< botVerificationParameters > &&  verification_parameters_,
bool  can_get_revenue_statistics_,
bool  can_manage_emoji_status_,
bool  has_media_previews_,
object_ptr< InternalLinkType > &&  edit_commands_link_,
object_ptr< InternalLinkType > &&  edit_description_link_,
object_ptr< InternalLinkType > &&  edit_description_media_link_,
object_ptr< InternalLinkType > &&  edit_settings_link_ 
)

Contains information about a bot.

Parameters
[in]short_description_The text that is shown on the bot&#x27;s profile page and is sent together with the link when users share the bot.
[in]description_The text shown in the chat with the bot if the chat is empty.
[in]photo_Photo shown in the chat with the bot if the chat is empty; may be null.
[in]animation_Animation shown in the chat with the bot if the chat is empty; may be null.
[in]manager_bot_user_id_Identifier of the bot, which manages the bot; 0 if none or unknown; for owner of the bot only.
[in]menu_button_Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown.
[in]commands_List of the bot commands.
[in]privacy_policy_url_The HTTP link to the privacy policy of the bot. If empty, then /privacy command must be used if supported by the bot. If the command isn&#x27;t supported, then https://telegram.org/privacy-tpa must be opened.
[in]default_group_administrator_rights_Default administrator rights for adding the bot to basic group and supergroup chats; may be null.
[in]default_channel_administrator_rights_Default administrator rights for adding the bot to channels; may be null.
[in]affiliate_program_Information about the affiliate program of the bot; may be null if none.
[in]web_app_background_light_color_Default light background color for bot Web Apps; -1 if not specified.
[in]web_app_background_dark_color_Default dark background color for bot Web Apps; -1 if not specified.
[in]web_app_header_light_color_Default light header color for bot Web Apps; -1 if not specified.
[in]web_app_header_dark_color_Default dark header color for bot Web Apps; -1 if not specified.
[in]verification_parameters_Parameters of the verification that can be provided by the bot; may be null if none or the current user isn&#x27;t the owner of the bot.
[in]can_get_revenue_statistics_True, if the bot&#x27;s revenue statistics are available to the current user.
[in]can_manage_emoji_status_True, if the bot can manage emoji status of the current user.
[in]has_media_previews_True, if the bot has media previews.
[in]edit_commands_link_The internal link, which can be used to edit bot commands; may be null.
[in]edit_description_link_The internal link, which can be used to edit bot description; may be null.
[in]edit_description_media_link_The internal link, which can be used to edit the photo or animation shown in the chat with the bot if the chat is empty; may be null.
[in]edit_settings_link_The internal link, which can be used to edit bot settings; may be null.

Member Function Documentation

◆ store()

void td::td_api::botInfo::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ affiliate_program_

object_ptr<affiliateProgramInfo> td::td_api::botInfo::affiliate_program_

Information about the affiliate program of the bot; may be null if none.

Definition at line 4630 of file td_api.h.

◆ animation_

object_ptr<animation> td::td_api::botInfo::animation_

Animation shown in the chat with the bot if the chat is empty; may be null.

Definition at line 4616 of file td_api.h.

◆ can_get_revenue_statistics_

bool td::td_api::botInfo::can_get_revenue_statistics_

True, if the bot&#x27;s revenue statistics are available to the current user.

Definition at line 4642 of file td_api.h.

◆ can_manage_emoji_status_

bool td::td_api::botInfo::can_manage_emoji_status_

True, if the bot can manage emoji status of the current user.

Definition at line 4644 of file td_api.h.

◆ commands_

array<object_ptr<botCommand> > td::td_api::botInfo::commands_

List of the bot commands.

Definition at line 4622 of file td_api.h.

◆ default_channel_administrator_rights_

object_ptr<chatAdministratorRights> td::td_api::botInfo::default_channel_administrator_rights_

Default administrator rights for adding the bot to channels; may be null.

Definition at line 4628 of file td_api.h.

◆ default_group_administrator_rights_

object_ptr<chatAdministratorRights> td::td_api::botInfo::default_group_administrator_rights_

Default administrator rights for adding the bot to basic group and supergroup chats; may be null.

Definition at line 4626 of file td_api.h.

◆ description_

string td::td_api::botInfo::description_

The text shown in the chat with the bot if the chat is empty.

Definition at line 4612 of file td_api.h.

◆ edit_commands_link_

object_ptr<InternalLinkType> td::td_api::botInfo::edit_commands_link_

The internal link, which can be used to edit bot commands; may be null.

Definition at line 4648 of file td_api.h.

◆ edit_description_link_

object_ptr<InternalLinkType> td::td_api::botInfo::edit_description_link_

The internal link, which can be used to edit bot description; may be null.

Definition at line 4650 of file td_api.h.

◆ edit_description_media_link_

object_ptr<InternalLinkType> td::td_api::botInfo::edit_description_media_link_

The internal link, which can be used to edit the photo or animation shown in the chat with the bot if the chat is empty; may be null.

Definition at line 4652 of file td_api.h.

◆ edit_settings_link_

object_ptr<InternalLinkType> td::td_api::botInfo::edit_settings_link_

The internal link, which can be used to edit bot settings; may be null.

Definition at line 4654 of file td_api.h.

◆ has_media_previews_

bool td::td_api::botInfo::has_media_previews_

True, if the bot has media previews.

Definition at line 4646 of file td_api.h.

◆ ID

const std::int32_t td::td_api::botInfo::ID = -586441582
static

Identifier uniquely determining a type of the object.

Definition at line 4691 of file td_api.h.

◆ manager_bot_user_id_

int53 td::td_api::botInfo::manager_bot_user_id_

Identifier of the bot, which manages the bot; 0 if none or unknown; for owner of the bot only.

Definition at line 4618 of file td_api.h.

◆ menu_button_

object_ptr<botMenuButton> td::td_api::botInfo::menu_button_

Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown.

Definition at line 4620 of file td_api.h.

◆ photo_

object_ptr<photo> td::td_api::botInfo::photo_

Photo shown in the chat with the bot if the chat is empty; may be null.

Definition at line 4614 of file td_api.h.

◆ privacy_policy_url_

string td::td_api::botInfo::privacy_policy_url_

The HTTP link to the privacy policy of the bot. If empty, then /privacy command must be used if supported by the bot. If the command isn&#x27;t supported, then https://telegram.org/privacy-tpa must be opened.

Definition at line 4624 of file td_api.h.

◆ short_description_

string td::td_api::botInfo::short_description_

The text that is shown on the bot&#x27;s profile page and is sent together with the link when users share the bot.

Definition at line 4610 of file td_api.h.

◆ verification_parameters_

object_ptr<botVerificationParameters> td::td_api::botInfo::verification_parameters_

Parameters of the verification that can be provided by the bot; may be null if none or the current user isn&#x27;t the owner of the bot.

Definition at line 4640 of file td_api.h.

◆ web_app_background_dark_color_

int32 td::td_api::botInfo::web_app_background_dark_color_

Default dark background color for bot Web Apps; -1 if not specified.

Definition at line 4634 of file td_api.h.

◆ web_app_background_light_color_

int32 td::td_api::botInfo::web_app_background_light_color_

Default light background color for bot Web Apps; -1 if not specified.

Definition at line 4632 of file td_api.h.

◆ web_app_header_dark_color_

int32 td::td_api::botInfo::web_app_header_dark_color_

Default dark header color for bot Web Apps; -1 if not specified.

Definition at line 4638 of file td_api.h.

◆ web_app_header_light_color_

int32 td::td_api::botInfo::web_app_header_light_color_

Default light header color for bot Web Apps; -1 if not specified.

Definition at line 4636 of file td_api.h.


The documentation for this class was generated from the following file: