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

Inherits Function.

Description

Changes the pinned state of a forum topic; requires can_manage_topics right in the supergroup. There can be up to getOption("pinned_forum_topic_count_max") pinned forum topics.

Returns object_ptr<Ok>.

Public Fields

int53 chat_id_
 Chat identifier.
 
int53 message_thread_id_
 Message thread identifier of the forum topic.
 
bool is_pinned_
 Pass true to pin the topic; pass false to unpin it.
 

Public Types

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

Public Instance Methods

 toggleForumTopicIsPinned ()
 
 toggleForumTopicIsPinned (int53 chat_id_, int53 message_thread_id_, bool is_pinned_)
 
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 = 1181543092
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ toggleForumTopicIsPinned() [1/2]

Default constructor for a function, which changes the pinned state of a forum topic; requires can_manage_topics right in the supergroup. There can be up to getOption("pinned_forum_topic_count_max") pinned forum topics.

Returns object_ptr<Ok>.

◆ toggleForumTopicIsPinned() [2/2]

toggleForumTopicIsPinned ( int53  chat_id_,
int53  message_thread_id_,
bool  is_pinned_ 
)

Creates a function, which changes the pinned state of a forum topic; requires can_manage_topics right in the supergroup. There can be up to getOption("pinned_forum_topic_count_max") pinned forum topics.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]message_thread_id_Message thread identifier of the forum topic.
[in]is_pinned_Pass true to pin the topic; pass false to unpin 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: