TDLib
Loading...
Searching...
No Matches
toggleSupergroupJoinByRequest Class Referencefinal

Inherits Function.

Description

Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

void store (TlStorerToString &s, const char *field_name) const final
 toggleSupergroupJoinByRequest ()
 toggleSupergroupJoinByRequest (int53 supergroup_id_, bool join_by_request_, int53 guard_bot_user_id_, bool apply_to_invite_links_)
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

bool apply_to_invite_links_
 Pass true to apply the change to the existing invite links, including primary links.
int53 guard_bot_user_id_
 Identifier of the bot which will be the guard bot in the group; pass 0 if none; ignored if join_by_request == false. The bot must have administrator privileges and can_invite_users right in the supergroup chat, and must have userTypeBot.is_guard == true.
bool join_by_request_
 New value of join_by_request.
int53 supergroup_id_
 Identifier of the supergroup that isn't a broadcast group and isn't a channel direct message group.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ toggleSupergroupJoinByRequest() [1/2]

toggleSupergroupJoinByRequest ( )

Default constructor for a function, which toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right.

Returns object_ptr<Ok>.

◆ toggleSupergroupJoinByRequest() [2/2]

toggleSupergroupJoinByRequest ( int53 supergroup_id_,
bool join_by_request_,
int53 guard_bot_user_id_,
bool apply_to_invite_links_ )

Creates a function, which toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right.

Returns object_ptr<Ok>.

Parameters
[in]supergroup_id_Identifier of the supergroup that isn't a broadcast group and isn't a channel direct message group.
[in]join_by_request_New value of join_by_request.
[in]guard_bot_user_id_Identifier of the bot which will be the guard bot in the group; pass 0 if none; ignored if join_by_request == false. The bot must have administrator privileges and can_invite_users right in the supergroup chat, and must have userTypeBot.is_guard == true.
[in]apply_to_invite_links_Pass true to apply the change to the existing invite links, including primary links.

Member Function 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: