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

Inherits Object.

Description

Describes active stories posted by a chat.

Public Member Functions

 chatActiveStories ()
 chatActiveStories (int53 chat_id_, object_ptr< StoryList > &&list_, int53 order_, bool can_be_archived_, int32 max_read_story_id_, array< object_ptr< storyInfo > > &&stories_)
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

bool can_be_archived_
 True, if the stories are shown in the main story list and can be archived; otherwise, the stories can be hidden from the main story list only by calling removeTopChat with topChatCategoryUsers and the chat_id. Stories of the current user can't be archived nor hidden using removeTopChat.
int53 chat_id_
 Identifier of the chat that posted the stories.
object_ptr< StoryList > list_
 Identifier of the story list in which the stories are shown; may be null if the stories aren't shown in a story list.
int32 max_read_story_id_
 Identifier of the last read active story.
int53 order_
 A parameter used to determine order of the stories in the story list; 0 if the stories don't need to be shown in the story list. Stories must be sorted by the pair (order, story_poster_chat_id) in descending order.
array< object_ptr< storyInfo > > stories_
 Basic information about the stories; use getStory to get full information about the stories. The stories are in chronological order (i.e., in order of increasing story identifiers).

Static Public Attributes

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

Constructor & Destructor Documentation

◆ chatActiveStories() [1/2]

chatActiveStories ( )

Describes active stories posted by a chat.

◆ chatActiveStories() [2/2]

chatActiveStories ( int53 chat_id_,
object_ptr< StoryList > && list_,
int53 order_,
bool can_be_archived_,
int32 max_read_story_id_,
array< object_ptr< storyInfo > > && stories_ )

Describes active stories posted by a chat.

Parameters
[in]chat_id_Identifier of the chat that posted the stories.
[in]list_Identifier of the story list in which the stories are shown; may be null if the stories aren't shown in a story list.
[in]order_A parameter used to determine order of the stories in the story list; 0 if the stories don't need to be shown in the story list. Stories must be sorted by the pair (order, story_poster_chat_id) in descending order.
[in]can_be_archived_True, if the stories are shown in the main story list and can be archived; otherwise, the stories can be hidden from the main story list only by calling removeTopChat with topChatCategoryUsers and the chat_id. Stories of the current user can't be archived nor hidden using removeTopChat.
[in]max_read_story_id_Identifier of the last read active story.
[in]stories_Basic information about the stories; use getStory to get full information about the stories. The stories are in chronological order (i.e., in order of increasing story identifiers).

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: