tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::editForumTopic Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::editForumTopic:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

 editForumTopic ()
 
 editForumTopic (int53 chat_id_, int32 forum_topic_id_, string const &name_, bool edit_icon_custom_emoji_, int64 icon_custom_emoji_id_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::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
 

Public Attributes

int53 chat_id_
 Identifier of the chat.
 
int32 forum_topic_id_
 Forum topic identifier.
 
string name_
 New name of the topic; 0-128 characters. If empty, the previous topic name is kept.
 
bool edit_icon_custom_emoji_
 Pass true to edit the icon of the topic. Icon of the General topic can&#x27;t be edited.
 
int64 icon_custom_emoji_id_
 Identifier of the new custom emoji for topic icon; pass 0 to remove the custom emoji. Ignored if edit_icon_custom_emoji is false. Telegram Premium users can use any custom emoji, other users can use only a custom emoji returned by getForumTopicDefaultIcons.
 

Static Public Attributes

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

Detailed Description

Edits title and icon of a topic in a forum supergroup chat or a chat with a bot with topics; for supergroup chats requires can_manage_topics administrator right unless the user is creator of the topic.

Returns object_ptr<Ok>.

Definition at line 98165 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 98210 of file td_api.h.

Constructor & Destructor Documentation

◆ editForumTopic() [1/2]

td::td_api::editForumTopic::editForumTopic ( )

Default constructor for a function, which edits title and icon of a topic in a forum supergroup chat or a chat with a bot with topics; for supergroup chats requires can_manage_topics administrator right unless the user is creator of the topic.

Returns object_ptr<Ok>.

◆ editForumTopic() [2/2]

td::td_api::editForumTopic::editForumTopic ( int53  chat_id_,
int32  forum_topic_id_,
string const &  name_,
bool  edit_icon_custom_emoji_,
int64  icon_custom_emoji_id_ 
)

Creates a function, which edits title and icon of a topic in a forum supergroup chat or a chat with a bot with topics; for supergroup chats requires can_manage_topics administrator right unless the user is creator of the topic.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Identifier of the chat.
[in]forum_topic_id_Forum topic identifier.
[in]name_New name of the topic; 0-128 characters. If empty, the previous topic name is kept.
[in]edit_icon_custom_emoji_Pass true to edit the icon of the topic. Icon of the General topic can&#x27;t be edited.
[in]icon_custom_emoji_id_Identifier of the new custom emoji for topic icon; pass 0 to remove the custom emoji. Ignored if edit_icon_custom_emoji is false. Telegram Premium users can use any custom emoji, other users can use only a custom emoji returned by getForumTopicDefaultIcons.

Member Function Documentation

◆ store()

void td::td_api::editForumTopic::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 td::TlObject.

Member Data Documentation

◆ chat_id_

int53 td::td_api::editForumTopic::chat_id_

Identifier of the chat.

Definition at line 98176 of file td_api.h.

◆ edit_icon_custom_emoji_

bool td::td_api::editForumTopic::edit_icon_custom_emoji_

Pass true to edit the icon of the topic. Icon of the General topic can&#x27;t be edited.

Definition at line 98182 of file td_api.h.

◆ forum_topic_id_

int32 td::td_api::editForumTopic::forum_topic_id_

Forum topic identifier.

Definition at line 98178 of file td_api.h.

◆ icon_custom_emoji_id_

int64 td::td_api::editForumTopic::icon_custom_emoji_id_

Identifier of the new custom emoji for topic icon; pass 0 to remove the custom emoji. Ignored if edit_icon_custom_emoji is false. Telegram Premium users can use any custom emoji, other users can use only a custom emoji returned by getForumTopicDefaultIcons.

Definition at line 98184 of file td_api.h.

◆ ID

const std::int32_t td::td_api::editForumTopic::ID = 1112389547
static

Identifier uniquely determining a type of the object.

Definition at line 98207 of file td_api.h.

◆ name_

string td::td_api::editForumTopic::name_

New name of the topic; 0-128 characters. If empty, the previous topic name is kept.

Definition at line 98180 of file td_api.h.


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