TDLib
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
sendMessageViewMetrics Class Referencefinal

Inherits Function.

Description

Informs TDLib about details of a message view by the user from a chat, a message thread or a forum topic history. The method must be called if the message wasn't seen for more than 300 milliseconds, the viewport was destroyed, or the total view duration exceeded 5 minutes.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 sendMessageViewMetrics ()
 
 sendMessageViewMetrics (int53 chat_id_, int53 message_id_, int32 time_in_view_ms_, int32 active_time_in_view_ms_, int32 height_to_viewport_ratio_per_mille_, int32 seen_range_ratio_per_mille_)
 
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 active_time_in_view_ms_
 The amount of time the message was seen by at least 1 pixel within 15 seconds after any action from the user; in milliseconds.
 
int53 chat_id_
 Chat identifier.
 
int32 height_to_viewport_ratio_per_mille_
 The ratio of the post height to the viewport height in 1/1000 fractions.
 
int53 message_id_
 The identifier of the message being viewed.
 
int32 seen_range_ratio_per_mille_
 The ratio of the viewed post height to the full post height in 1/1000 fractions; 0-1000.
 
int32 time_in_view_ms_
 The amount of time the message was seen by at least 1 pixel; in milliseconds.
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ sendMessageViewMetrics() [1/2]

Default constructor for a function, which informs TDLib about details of a message view by the user from a chat, a message thread or a forum topic history. The method must be called if the message wasn't seen for more than 300 milliseconds, the viewport was destroyed, or the total view duration exceeded 5 minutes.

Returns object_ptr<Ok>.

◆ sendMessageViewMetrics() [2/2]

sendMessageViewMetrics ( int53  chat_id_,
int53  message_id_,
int32  time_in_view_ms_,
int32  active_time_in_view_ms_,
int32  height_to_viewport_ratio_per_mille_,
int32  seen_range_ratio_per_mille_ 
)

Creates a function, which informs TDLib about details of a message view by the user from a chat, a message thread or a forum topic history. The method must be called if the message wasn't seen for more than 300 milliseconds, the viewport was destroyed, or the total view duration exceeded 5 minutes.

Returns object_ptr<Ok>.

Parameters
[in]chat_id_Chat identifier.
[in]message_id_The identifier of the message being viewed.
[in]time_in_view_ms_The amount of time the message was seen by at least 1 pixel; in milliseconds.
[in]active_time_in_view_ms_The amount of time the message was seen by at least 1 pixel within 15 seconds after any action from the user; in milliseconds.
[in]height_to_viewport_ratio_per_mille_The ratio of the post height to the viewport height in 1/1000 fractions.
[in]seen_range_ratio_per_mille_The ratio of the viewed post height to the full post height in 1/1000 fractions; 0-1000.

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: