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

Inherits Function.

Description

Pins a message in a supergroup or channel; requires appropriate administrator rights in the supergroup or channel.

Returns object_ptr<Ok>.

Public Fields

std::int32_t supergroup_id_
 Identifier of the supergroup or channel.
 
std::int64_t message_id_
 Identifier of the new pinned message.
 
bool disable_notification_
 True, if there should be no notification about the pinned message.
 

Public Types

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

Public Instance Methods

 pinSupergroupMessage ()
 
 pinSupergroupMessage (std::int32_t supergroup_id_, std::int64_t message_id_, bool disable_notification_)
 
std::int32_t get_id () const final
 
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 = 1141187557
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ pinSupergroupMessage() [1/2]

Default constructor. All fields will be value-initilaized.

◆ pinSupergroupMessage() [2/2]

pinSupergroupMessage ( std::int32_t  supergroup_id_,
std::int64_t  message_id_,
bool  disable_notification_ 
)

Constructor for initialization of all fields.

Parameters
[in]supergroup_id_Identifier of the supergroup or channel.
[in]message_id_Identifier of the new pinned message.
[in]disable_notification_True, if there should be no notification about the pinned message.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ 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: