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

Inherits Function.

Description

Changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channel. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached.

Returns object_ptr<Ok>.

Public Fields

int53 supergroup_id_
 Identifier of the supergroup or channel.
 
string username_
 The username to change.
 
bool is_active_
 Pass true to activate the username; pass false to disable it.
 

Public Types

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

Public Instance Methods

 toggleSupergroupUsernameIsActive ()
 
 toggleSupergroupUsernameIsActive (int53 supergroup_id_, string const &username_, bool is_active_)
 
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 = -1500811777
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ toggleSupergroupUsernameIsActive() [1/2]

Default constructor for a function, which changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channel. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached.

Returns object_ptr<Ok>.

◆ toggleSupergroupUsernameIsActive() [2/2]

toggleSupergroupUsernameIsActive ( int53  supergroup_id_,
string const &  username_,
bool  is_active_ 
)

Creates a function, which changes active state for a username of a supergroup or channel, requires owner privileges in the supergroup or channel. The editable username can't be disabled. May return an error with a message "USERNAMES_ACTIVE_TOO_MUCH" if the maximum number of active usernames has been reached.

Returns object_ptr<Ok>.

Parameters
[in]supergroup_id_Identifier of the supergroup or channel.
[in]username_The username to change.
[in]is_active_Pass true to activate the username; pass false to disable it.

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: