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

Inherits Function.

Description

Returns interactions with a story. The method can be called only for stories posted on behalf of the current user.

Returns object_ptr<StoryInteractions>.

Public Types

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

Public Member Functions

 getStoryInteractions ()
 getStoryInteractions (int32 story_id_, string const &query_, bool only_contacts_, bool prefer_forwards_, bool prefer_with_reaction_, string const &offset_, 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

int32 limit_
 The maximum number of story interactions to return.
string offset_
 Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
bool only_contacts_
 Pass true to get only interactions by contacts; pass false to get all relevant interactions.
bool prefer_forwards_
 Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date.
bool prefer_with_reaction_
 Pass true to get interactions with reaction first; pass false to get interactions sorted just by interaction date. Ignored if prefer_forwards == true.
string query_
 Query to search for in names, usernames and titles; may be empty to get all relevant interactions.
int32 story_id_
 Story identifier.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getStoryInteractions() [1/2]

getStoryInteractions ( )

Default constructor for a function, which returns interactions with a story. The method can be called only for stories posted on behalf of the current user.

Returns object_ptr<StoryInteractions>.

◆ getStoryInteractions() [2/2]

getStoryInteractions ( int32 story_id_,
string const & query_,
bool only_contacts_,
bool prefer_forwards_,
bool prefer_with_reaction_,
string const & offset_,
int32 limit_ )

Creates a function, which returns interactions with a story. The method can be called only for stories posted on behalf of the current user.

Returns object_ptr<StoryInteractions>.

Parameters
[in]story_id_Story identifier.
[in]query_Query to search for in names, usernames and titles; may be empty to get all relevant interactions.
[in]only_contacts_Pass true to get only interactions by contacts; pass false to get all relevant interactions.
[in]prefer_forwards_Pass true to get forwards and reposts first, then reactions, then other views; pass false to get interactions sorted just by interaction date.
[in]prefer_with_reaction_Pass true to get interactions with reaction first; pass false to get interactions sorted just by interaction date. Ignored if prefer_forwards == true.
[in]offset_Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
[in]limit_The maximum number of story interactions to return.

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: