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

Inherits Function.

Description

Returns forwarded copies of a channel message to different public channels and public reposts as a story. Can be used only if messageProperties.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib.

Returns object_ptr<PublicForwards>.

Public Types

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

Public Member Functions

 getMessagePublicForwards ()
 getMessagePublicForwards (int53 chat_id_, int53 message_id_, 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

int53 chat_id_
 Chat identifier of the message.
int32 limit_
 The maximum number of messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects is chosen by TDLib and can be smaller than the specified limit.
int53 message_id_
 Message identifier.
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.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getMessagePublicForwards() [1/2]

getMessagePublicForwards ( )

Default constructor for a function, which returns forwarded copies of a channel message to different public channels and public reposts as a story. Can be used only if messageProperties.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib.

Returns object_ptr<PublicForwards>.

◆ getMessagePublicForwards() [2/2]

getMessagePublicForwards ( int53 chat_id_,
int53 message_id_,
string const & offset_,
int32 limit_ )

Creates a function, which returns forwarded copies of a channel message to different public channels and public reposts as a story. Can be used only if messageProperties.can_get_statistics == true. For optimal performance, the number of returned messages and stories is chosen by TDLib.

Returns object_ptr<PublicForwards>.

Parameters
[in]chat_id_Chat identifier of the message.
[in]message_id_Message identifier.
[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 messages and stories to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned objects 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: