Class TdApi.SetGameScore

  • Enclosing class:
    TdApi

    public static class TdApi.SetGameScore
    extends TdApi.Function
    Updates the game score of the specified user in the game; for bots only.

    Returns Message

    • Field Summary

      Fields 
      Modifier and Type Field Description
      long chatId
      The chat to which the message with the game belongs.
      static int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      boolean editMessage
      True, if the message needs to be edited.
      boolean force
      Pass true to update the score even if it decreases.
      long messageId
      Identifier of the message.
      int score
      The new score.
      long userId
      User identifier.
    • Constructor Summary

      Constructors 
      Constructor Description
      SetGameScore()
      Default constructor for a function, which updates the game score of the specified user in the game; for bots only.
      SetGameScore​(long chatId, long messageId, boolean editMessage, long userId, int score, boolean force)
      Creates a function, which updates the game score of the specified user in the game; for bots only.
    • Field Detail

      • chatId

        public long chatId
        The chat to which the message with the game belongs.
      • messageId

        public long messageId
        Identifier of the message.
      • editMessage

        public boolean editMessage
        True, if the message needs to be edited.
      • userId

        public long userId
        User identifier.
      • score

        public int score
        The new score.
      • force

        public boolean 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.
      • CONSTRUCTOR

        public static final int CONSTRUCTOR
        Identifier uniquely determining type of the object.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SetGameScore

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

        Returns Message

      • SetGameScore

        public SetGameScore​(long chatId,
                            long messageId,
                            boolean editMessage,
                            long userId,
                            int score,
                            boolean force)
        Creates a function, which updates the game score of the specified user in the game; for bots only.

        Returns Message

        Parameters:
        chatId - The chat to which the message with the game belongs.
        messageId - Identifier of the message.
        editMessage - True, if the message needs to be edited.
        userId - User identifier.
        score - The new score.
        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.