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::getStoryInteractions Class Referencefinal

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

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

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 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

int32 story_id_
 Story identifier.
 
string query_
 Query to search for in names, usernames and titles; may be empty to get all relevant interactions.
 
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 offset_
 Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
 
int32 limit_
 The maximum number of story interactions to return.
 

Static Public Attributes

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

Detailed 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>.

Definition at line 113631 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 113682 of file td_api.h.

Constructor & Destructor Documentation

◆ getStoryInteractions() [1/2]

td::td_api::getStoryInteractions::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]

td::td_api::getStoryInteractions::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 td::td_api::getStoryInteractions::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

◆ ID

const std::int32_t td::td_api::getStoryInteractions::ID = 483475469
static

Identifier uniquely determining a type of the object.

Definition at line 113679 of file td_api.h.

◆ limit_

int32 td::td_api::getStoryInteractions::limit_

The maximum number of story interactions to return.

Definition at line 113654 of file td_api.h.

◆ offset_

string td::td_api::getStoryInteractions::offset_

Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.

Definition at line 113652 of file td_api.h.

◆ only_contacts_

bool td::td_api::getStoryInteractions::only_contacts_

Pass true to get only interactions by contacts; pass false to get all relevant interactions.

Definition at line 113646 of file td_api.h.

◆ prefer_forwards_

bool td::td_api::getStoryInteractions::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.

Definition at line 113648 of file td_api.h.

◆ prefer_with_reaction_

bool td::td_api::getStoryInteractions::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.

Definition at line 113650 of file td_api.h.

◆ query_

string td::td_api::getStoryInteractions::query_

Query to search for in names, usernames and titles; may be empty to get all relevant interactions.

Definition at line 113644 of file td_api.h.

◆ story_id_

int32 td::td_api::getStoryInteractions::story_id_

Story identifier.

Definition at line 113642 of file td_api.h.


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