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

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

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

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

int53 chat_id_
 Chat identifier.
 
int53 message_id_
 The identifier of the message being viewed.
 
int32 time_in_view_ms_
 The amount of time the message was seen by at least 1 pixel; in milliseconds.
 
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.
 
int32 height_to_viewport_ratio_per_mille_
 The ratio of the post height to the viewport height in 1/1000 fractions.
 
int32 seen_range_ratio_per_mille_
 The ratio of the viewed post height to the full post height in 1/1000 fractions; 0-1000.
 

Static Public Attributes

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

Detailed 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&#x27;t seen for more than 300 milliseconds, the viewport was destroyed, or the total view duration exceeded 5 minutes.

Returns object_ptr<Ok>.

Definition at line 126441 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 126489 of file td_api.h.

Constructor & Destructor Documentation

◆ sendMessageViewMetrics() [1/2]

td::td_api::sendMessageViewMetrics::sendMessageViewMetrics ( )

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&#x27;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]

td::td_api::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_ 
)

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&#x27;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 td::td_api::sendMessageViewMetrics::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

◆ active_time_in_view_ms_

int32 td::td_api::sendMessageViewMetrics::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.

Definition at line 126458 of file td_api.h.

◆ chat_id_

int53 td::td_api::sendMessageViewMetrics::chat_id_

Chat identifier.

Definition at line 126452 of file td_api.h.

◆ height_to_viewport_ratio_per_mille_

int32 td::td_api::sendMessageViewMetrics::height_to_viewport_ratio_per_mille_

The ratio of the post height to the viewport height in 1/1000 fractions.

Definition at line 126460 of file td_api.h.

◆ ID

const std::int32_t td::td_api::sendMessageViewMetrics::ID = 698012087
static

Identifier uniquely determining a type of the object.

Definition at line 126486 of file td_api.h.

◆ message_id_

int53 td::td_api::sendMessageViewMetrics::message_id_

The identifier of the message being viewed.

Definition at line 126454 of file td_api.h.

◆ seen_range_ratio_per_mille_

int32 td::td_api::sendMessageViewMetrics::seen_range_ratio_per_mille_

The ratio of the viewed post height to the full post height in 1/1000 fractions; 0-1000.

Definition at line 126462 of file td_api.h.

◆ time_in_view_ms_

int32 td::td_api::sendMessageViewMetrics::time_in_view_ms_

The amount of time the message was seen by at least 1 pixel; in milliseconds.

Definition at line 126456 of file td_api.h.


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