viewMessages Class Reference

Inherits Function.

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

Public Fields
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 the chat is closed.

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

Public Instance Methods
	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 Instance Methods inherited from 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

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

Constructor & Destructor Documentation

viewMessages() [1/2]

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]

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 the chat is closed.

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

Implements TlObject.

---

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

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