Class Game

constructor

• new Game(client: TelegramClient | BaseClient, data: Game): Game

  Parameters

  • client: TelegramClient | BaseClient

    The client that instantiated this

  • data: Game

    Data about the represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers

  Returns Game

animation

description

entities

photo

text

title

fetchHighScores

• fetchHighScores(
      userId: string | number,
      options?: Omit<
          {
              chatId?: string
              | number;
              inlineMessageId?: string;
              messageId?: string | number;
              userId: string | number;
          },
          "userId",
      >,
  ): Promise<GameHighScore[]>

  Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game.

  Parameters

  • userId: string | number

    Target user id

  • Optionaloptions: Omit<
        {
            chatId?: string
            | number;
            inlineMessageId?: string;
            messageId?: string | number;
            userId: string | number;
        },
        "userId",
    >

    out parameters

  Returns Promise<GameHighScore[]>

  Returns an Array of GameHighScore objects. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

setScore

• setScore(
      userId: string | number,
      score: number,
      options?: Omit<
          {
              chatId?: string
              | number;
              disableEditMessage?: boolean;
              force?: boolean;
              inlineMessageId?: string;
              messageId?: string | number;
              score: number;
              userId: string | number;
          },
          "userId"
          | "score",
      >,
  ): Promise<boolean | Message & { editedTimestamp: number; game: Game }>

  Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned.

  Parameters

  • userId: string | number

    User identifier

  • score: number

    New score, must be non-negative

  • Optionaloptions: Omit<
        {
            chatId?: string
            | number;
            disableEditMessage?: boolean;
            force?: boolean;
            inlineMessageId?: string;
            messageId?: string | number;
            score: number;
            userId: string | number;
        },
        "userId"
        | "score",
    >

    out parameters

  Returns Promise<boolean | Message & { editedTimestamp: number; game: Game }>

  On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.