td::td_api::viewMessages Class Reference

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

Inheritance diagram for td::td_api::viewMessages:

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

Public Member Functions
	viewMessages ()
	viewMessages (int53 chat_id_, array< int53 > &&message_ids_, object_ptr< MessageSource > &&source_, bool force_read_)
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
int53	chat_id_
	Chat identifier.
array< int53 >	message_ids_
	The identifiers of the messages being viewed.
object_ptr< MessageSource >	source_
	Source of the message view; pass null to guess the source based on chat open state.
bool	force_read_
	Pass true to mark as read the specified messages even if the chat is closed.

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

Detailed Description

Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels).

Returns object_ptr<Ok>.

Definition at line 139036 of file td_api.h.

Member Typedef Documentation

ReturnType

using td::td_api::viewMessages::ReturnType = object_ptr<ok>

Typedef for the type returned by the function.

Definition at line 139078 of file td_api.h.

Constructor & Destructor Documentation

viewMessages() [1/2]

td::td_api::viewMessages::viewMessages

(

)

Default constructor for a function, which informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels).

Returns object_ptr<Ok>.

viewMessages() [2/2]

td::td_api::viewMessages::viewMessages	(	int53	chat_id_,
		array< int53 > &&	message_ids_,
		object_ptr< MessageSource > &&	source_,
		bool	force_read_
	)

Creates a function, which informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels).

Returns object_ptr<Ok>.

Parameters

[in]	chat_id_	Chat identifier.
[in]	message_ids_	The identifiers of the messages being viewed.
[in]	source_	Source of the message view; pass null to guess the source based on chat open state.
[in]	force_read_	Pass true to mark as read the specified messages even if the chat is closed.

Member Function Documentation

store()

void td::td_api::viewMessages::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.

Member Data Documentation

chat_id_

int53 td::td_api::viewMessages::chat_id_

Chat identifier.

Definition at line 139047 of file td_api.h.

force_read_

bool td::td_api::viewMessages::force_read_

Pass true to mark as read the specified messages even if the chat is closed.

Definition at line 139053 of file td_api.h.

ID

const std::int32_t td::td_api::viewMessages::ID = 960236656

static

Identifier uniquely determining a type of the object.

Definition at line 139075 of file td_api.h.

message_ids_

array<int53> td::td_api::viewMessages::message_ids_

The identifiers of the messages being viewed.

Definition at line 139049 of file td_api.h.

source_

object_ptr<MessageSource> td::td_api::viewMessages::source_

Source of the message view; pass null to guess the source based on chat open state.

Definition at line 139051 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h