TDLib
Loading...
Searching...
No Matches
setGameScore Class Referencefinal

Inherits Function.

Description

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

Returns object_ptr<Message>.

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

int53 chat_id_
 The chat to which the message with the game belongs.
bool edit_message_
 Pass true to edit the game message to include the current scoreboard.
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.
int53 message_id_
 Identifier of the message.
int32 score_
 The new score.
int53 user_id_
 User identifier.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ setGameScore() [1/2]

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]

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

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