td::td_api::getStoryViewers Class Reference

Inherits td::td_api::Function.

Public Types
using	ReturnType = object_ptr< storyViewers >
	Typedef for the type returned by the function.

Public Member Functions
	getStoryViewers ()
	getStoryViewers (int32 story_id_, string const &query_, bool only_contacts_, bool prefer_with_reaction_, string const &offset_, int32 limit_)
std::int32_t	get_id () const final
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
int32	story_id_
	Story identifier.
string	query_
	Query to search for in names and usernames of the viewers; may be empty to get all relevant viewers.
bool	only_contacts_
	Pass true to get only contacts; pass false to get all relevant viewers.
bool	prefer_with_reaction_
	Pass true to get viewers with reaction first; pass false to get viewers sorted just by view_date.
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 viewers to return.

Static Public Attributes
static const std::int32_t	ID = 1088392634
	Identifier uniquely determining a type of the object.

Detailed Description

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

Returns object_ptr<StoryViewers>.

Constructor & Destructor Documentation

getStoryViewers() [1/2]

td::td_api::getStoryViewers::getStoryViewers

(

)

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

Returns object_ptr<StoryViewers>.

getStoryViewers() [2/2]

td::td_api::getStoryViewers::getStoryViewers	(	int32	story_id_,
		string const &	query_,
		bool	only_contacts_,
		bool	prefer_with_reaction_,
		string const &	offset_,
		int32	limit_
	)

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

Returns object_ptr<StoryViewers>.

Parameters

[in]	story_id_	Story identifier.
[in]	query_	Query to search for in names and usernames of the viewers; may be empty to get all relevant viewers.
[in]	only_contacts_	Pass true to get only contacts; pass false to get all relevant viewers.
[in]	prefer_with_reaction_	Pass true to get viewers with reaction first; pass false to get viewers sorted just by view_date.
[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 viewers to return.

Member Function Documentation

get_id()

std::int32_t td::td_api::getStoryViewers::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

void td::td_api::getStoryViewers::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h