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::shareChatWithBot Class Referencefinal

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

Inheritance diagram for td::td_api::shareChatWithBot:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Member Functions

 shareChatWithBot ()
 
 shareChatWithBot (object_ptr< KeyboardButtonSource > &&source_, int32 button_id_, int53 shared_chat_id_, bool only_check_)
 
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

object_ptr< KeyboardButtonSourcesource_
 Source of the button.
 
int32 button_id_
 Identifier of the button.
 
int53 shared_chat_id_
 Identifier of the shared chat.
 
bool only_check_
 Pass true to check that the chat can be shared by the button instead of actually sharing it. Doesn&#x27;t check bot_is_member and bot_administrator_rights restrictions. If the bot must be a member, then all chats from getGroupsInCommon and all chats, where the user can add the bot, are suitable. In the latter case the bot will be automatically added to the chat. If the bot must be an administrator, then all chats, where the bot already has requested rights or can be added to administrators by the user, are suitable. In the latter case the bot will be automatically granted requested rights.
 

Static Public Attributes

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

Detailed Description

Shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot.

Returns object_ptr<Ok>.

Definition at line 134499 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 134541 of file td_api.h.

Constructor & Destructor Documentation

◆ shareChatWithBot() [1/2]

td::td_api::shareChatWithBot::shareChatWithBot ( )

Default constructor for a function, which shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot.

Returns object_ptr<Ok>.

◆ shareChatWithBot() [2/2]

td::td_api::shareChatWithBot::shareChatWithBot ( object_ptr< KeyboardButtonSource > &&  source_,
int32  button_id_,
int53  shared_chat_id_,
bool  only_check_ 
)

Creates a function, which shares a chat after pressing a keyboardButtonTypeRequestChat button with the bot.

Returns object_ptr<Ok>.

Parameters
[in]source_Source of the button.
[in]button_id_Identifier of the button.
[in]shared_chat_id_Identifier of the shared chat.
[in]only_check_Pass true to check that the chat can be shared by the button instead of actually sharing it. Doesn&#x27;t check bot_is_member and bot_administrator_rights restrictions. If the bot must be a member, then all chats from getGroupsInCommon and all chats, where the user can add the bot, are suitable. In the latter case the bot will be automatically added to the chat. If the bot must be an administrator, then all chats, where the bot already has requested rights or can be added to administrators by the user, are suitable. In the latter case the bot will be automatically granted requested rights.

Member Function Documentation

◆ store()

void td::td_api::shareChatWithBot::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

◆ button_id_

int32 td::td_api::shareChatWithBot::button_id_

Identifier of the button.

Definition at line 134512 of file td_api.h.

◆ ID

const std::int32_t td::td_api::shareChatWithBot::ID = -917243698
static

Identifier uniquely determining a type of the object.

Definition at line 134538 of file td_api.h.

◆ only_check_

bool td::td_api::shareChatWithBot::only_check_

Pass true to check that the chat can be shared by the button instead of actually sharing it. Doesn&#x27;t check bot_is_member and bot_administrator_rights restrictions. If the bot must be a member, then all chats from getGroupsInCommon and all chats, where the user can add the bot, are suitable. In the latter case the bot will be automatically added to the chat. If the bot must be an administrator, then all chats, where the bot already has requested rights or can be added to administrators by the user, are suitable. In the latter case the bot will be automatically granted requested rights.

Definition at line 134516 of file td_api.h.

◆ shared_chat_id_

int53 td::td_api::shareChatWithBot::shared_chat_id_

Identifier of the shared chat.

Definition at line 134514 of file td_api.h.

◆ source_

object_ptr<KeyboardButtonSource> td::td_api::shareChatWithBot::source_

Source of the button.

Definition at line 134510 of file td_api.h.


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