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

Inherits Function.

Description

Returns found forum topics in a forum supergroup chat or a chat with a bot with topics. This is a temporary method for getting information about topic list from the server.

Returns object_ptr<ForumTopics>.

Public Types

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

Public Member Functions

 getForumTopics ()
 getForumTopics (int53 chat_id_, string const &query_, int32 offset_date_, int53 offset_message_id_, int32 offset_forum_topic_id_, int32 limit_)
void store (TlStorerToString &s, const char *field_name) const final
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

int53 chat_id_
 Identifier of the chat.
int32 limit_
 The maximum number of forum topics to be returned; up to 100. For optimal performance, the number of returned forum topics is chosen by TDLib and can be smaller than the specified limit.
int32 offset_date_
 The date starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last topic.
int32 offset_forum_topic_id_
 The forum topic identifier of the last found topic, or 0 for the first request.
int53 offset_message_id_
 The message identifier of the last message in the last found topic, or 0 for the first request.
string query_
 Query to search for in the forum topic's name.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getForumTopics() [1/2]

getForumTopics ( )

Default constructor for a function, which returns found forum topics in a forum supergroup chat or a chat with a bot with topics. This is a temporary method for getting information about topic list from the server.

Returns object_ptr<ForumTopics>.

◆ getForumTopics() [2/2]

getForumTopics ( int53 chat_id_,
string const & query_,
int32 offset_date_,
int53 offset_message_id_,
int32 offset_forum_topic_id_,
int32 limit_ )

Creates a function, which returns found forum topics in a forum supergroup chat or a chat with a bot with topics. This is a temporary method for getting information about topic list from the server.

Returns object_ptr<ForumTopics>.

Parameters
[in]chat_id_Identifier of the chat.
[in]query_Query to search for in the forum topic's name.
[in]offset_date_The date starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last topic.
[in]offset_message_id_The message identifier of the last message in the last found topic, or 0 for the first request.
[in]offset_forum_topic_id_The forum topic identifier of the last found topic, or 0 for the first request.
[in]limit_The maximum number of forum topics to be returned; up to 100. For optimal performance, the number of returned forum topics is chosen by TDLib and can be smaller than the specified limit.

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: