List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
shareChatWithBot Class Referencefinal

Inherits Function.

Description

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

Returns object_ptr<Ok>.

Public Fields

int53 chat_id_
 Identifier of the chat with the bot.
 
int53 message_id_
 Identifier of the message with 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'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.
 

Public Types

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

Public Instance Methods

 shareChatWithBot ()
 
 shareChatWithBot (int53 chat_id_, int53 message_id_, int32 button_id_, int53 shared_chat_id_, bool only_check_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ shareChatWithBot() [1/2]

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

Returns object_ptr<Ok>.

◆ shareChatWithBot() [2/2]

shareChatWithBot ( int53  chat_id_,
int53  message_id_,
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]chat_id_Identifier of the chat with the bot.
[in]message_id_Identifier of the message with 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'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.

Method Documentation

◆ store()

void 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 TlObject.


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