td::td_api::setGameScore Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	setGameScore ()
	setGameScore (int53 chat_id_, int53 message_id_, bool edit_message_, int53 user_id_, int32 score_, bool force_)
std::int32_t	get_id () const final
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_
	The chat to which the message with the game belongs.
int53	message_id_
	Identifier of the message.
bool	edit_message_
	Pass true to edit the game message to include the current scoreboard.
int53	user_id_
	User identifier.
int32	score_
	The new score.
bool	force_
	Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table.

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

Detailed Description

Updates the game score of the specified user in the game; for bots only.

Returns object_ptr<Message>.

Constructor & Destructor Documentation

setGameScore() [1/2]

td::td_api::setGameScore::setGameScore

(

)

Default constructor for a function, which updates the game score of the specified user in the game; for bots only.

Returns object_ptr<Message>.

setGameScore() [2/2]

td::td_api::setGameScore::setGameScore	(	int53	chat_id_,
		int53	message_id_,
		bool	edit_message_,
		int53	user_id_,
		int32	score_,
		bool	force_
	)

Creates a function, which updates the game score of the specified user in the game; for bots only.

Returns object_ptr<Message>.

Parameters

[in]	chat_id_	The chat to which the message with the game belongs.
[in]	message_id_	Identifier of the message.
[in]	edit_message_	Pass true to edit the game message to include the current scoreboard.
[in]	user_id_	User identifier.
[in]	score_	The new score.
[in]	force_	Pass true to update the score even if it decreases. If the score is 0, the user will be deleted from the high score table.

Member Function Documentation

get_id()

std::int32_t td::td_api::setGameScore::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

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

---

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

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