Telegram.Bot.API.Games

Types

SendGameRequest

data SendGameRequest

Constructors

SendGameRequest

Fields

• sendGameChatId :: ChatId

  Unique identifier for the target chat.

• sendGameMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendGameGameShortName :: Text

  Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.

• sendGameDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendGameProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving.

• sendGameReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendGameAllowSendingWithoutReply :: Maybe Bool

  Pass True, if the message should be sent even if the specified replied-to message is not found

• sendGameReplyMarkup :: Maybe InlineKeyboardMarkup

  A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.

Instances

FromJSON SendGameRequest

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SendGameRequest

parseJSONList :: Value -> Parser [SendGameRequest]

ToJSON SendGameRequest

Defined in Telegram.Bot.API.Games

Methods

toJSON :: SendGameRequest -> Value

toEncoding :: SendGameRequest -> Encoding

toJSONList :: [SendGameRequest] -> Value

toEncodingList :: [SendGameRequest] -> Encoding

Generic SendGameRequest

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SendGameRequest :: Type -> Type

Methods

from :: SendGameRequest -> Rep SendGameRequest x

to :: Rep SendGameRequest x -> SendGameRequest

Show SendGameRequest

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SendGameRequest -> ShowS

show :: SendGameRequest -> String

showList :: [SendGameRequest] -> ShowS

type Rep SendGameRequest

Defined in Telegram.Bot.API.Games

type Rep SendGameRequest = D1 ('MetaData "SendGameRequest" "Telegram.Bot.API.Games" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "SendGameRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendGameChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatId) :*: S1 ('MetaSel ('Just "sendGameMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId))) :*: (S1 ('MetaSel ('Just "sendGameGameShortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "sendGameDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendGameProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendGameReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "sendGameAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendGameReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))

SetGameScoreRequest

data SetGameScoreRequest

Constructors

SetGameScoreRequest

Fields

• setGameScoreUserId :: UserId

  User identifier.

• setGameScoreScore :: Integer

  New score, must be non-negative.

• setGameScoreForce :: Maybe Bool

  Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.

• setGameScoreDisableEditMessage :: Maybe Bool

  Pass True, if the game message should not be automatically edited to include the current scoreboard.

• setGameScoreChatId :: Maybe ChatId

  Required if inline_message_id is not specified. Unique identifier for the target chat

• setGameScoreMessageId :: Maybe MessageId

  Required if inline_message_id is not specified. Identifier of the sent message.

• setGameScoreInlineMessageId :: Maybe MessageId

  Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

FromJSON SetGameScoreRequest

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SetGameScoreRequest

parseJSONList :: Value -> Parser [SetGameScoreRequest]

ToJSON SetGameScoreRequest

Defined in Telegram.Bot.API.Games

Methods

toJSON :: SetGameScoreRequest -> Value

toEncoding :: SetGameScoreRequest -> Encoding

toJSONList :: [SetGameScoreRequest] -> Value

toEncodingList :: [SetGameScoreRequest] -> Encoding

Generic SetGameScoreRequest

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SetGameScoreRequest :: Type -> Type

Methods

from :: SetGameScoreRequest -> Rep SetGameScoreRequest x

to :: Rep SetGameScoreRequest x -> SetGameScoreRequest

Show SetGameScoreRequest

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SetGameScoreRequest -> ShowS

show :: SetGameScoreRequest -> String

showList :: [SetGameScoreRequest] -> ShowS

type Rep SetGameScoreRequest

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreRequest = D1 ('MetaData "SetGameScoreRequest" "Telegram.Bot.API.Games" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "SetGameScoreRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "setGameScoreUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: (S1 ('MetaSel ('Just "setGameScoreScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "setGameScoreForce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "setGameScoreDisableEditMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "setGameScoreChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId))) :*: (S1 ('MetaSel ('Just "setGameScoreMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "setGameScoreInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))))))

SetGameScoreResult

data SetGameScoreResult

Constructors

SetGameScoreMessage Message

SetGameScoreMessageBool Bool

Instances

FromJSON SetGameScoreResult

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SetGameScoreResult

parseJSONList :: Value -> Parser [SetGameScoreResult]

ToJSON SetGameScoreResult

Defined in Telegram.Bot.API.Games

Methods

toJSON :: SetGameScoreResult -> Value

toEncoding :: SetGameScoreResult -> Encoding

toJSONList :: [SetGameScoreResult] -> Value

toEncodingList :: [SetGameScoreResult] -> Encoding

Generic SetGameScoreResult

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SetGameScoreResult :: Type -> Type

Methods

from :: SetGameScoreResult -> Rep SetGameScoreResult x

to :: Rep SetGameScoreResult x -> SetGameScoreResult

Show SetGameScoreResult

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SetGameScoreResult -> ShowS

show :: SetGameScoreResult -> String

showList :: [SetGameScoreResult] -> ShowS

type Rep SetGameScoreResult

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreResult = D1 ('MetaData "SetGameScoreResult" "Telegram.Bot.API.Games" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "SetGameScoreMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Message)) :+: C1 ('MetaCons "SetGameScoreMessageBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

GetGameHighScoresRequest

data GetGameHighScoresRequest

Constructors

GetGameHighScoresRequest

Fields

• getGameHighScoresUserId :: UserId

  Target user id.

• getGameHighScoresChatId :: Maybe ChatId

  Required if inline_message_id is not specified. Unique identifier for the target chat.

• getGameHighScoresMessageId :: Maybe MessageId

  Required if inline_message_id is not specified. Identifier of the sent message.

• getGameHighScoresInlineMessageId :: Maybe MessageId

  Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

Generic GetGameHighScoresRequest

Defined in Telegram.Bot.API.Games

Associated Types

type Rep GetGameHighScoresRequest :: Type -> Type

Methods

from :: GetGameHighScoresRequest -> Rep GetGameHighScoresRequest x

to :: Rep GetGameHighScoresRequest x -> GetGameHighScoresRequest

Show GetGameHighScoresRequest

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> GetGameHighScoresRequest -> ShowS

show :: GetGameHighScoresRequest -> String

showList :: [GetGameHighScoresRequest] -> ShowS

type Rep GetGameHighScoresRequest

Defined in Telegram.Bot.API.Games

type Rep GetGameHighScoresRequest = D1 ('MetaData "GetGameHighScoresRequest" "Telegram.Bot.API.Games" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "GetGameHighScoresRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "getGameHighScoresUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :*: S1 ('MetaSel ('Just "getGameHighScoresChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId))) :*: (S1 ('MetaSel ('Just "getGameHighScoresMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "getGameHighScoresInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)))))

Methods

sendGame

type SendGame = "sendGame" :> (ReqBody '[JSON] SendGameRequest :> Post '[JSON] (Response Message))

sendGame :: SendGameRequest -> ClientM (Response Message)

Use this method to send a game. On success, the sent Message is returned.

setGameScore

type SetGameScore = "setGameScore" :> (ReqBody '[JSON] SetGameScoreRequest :> Post '[JSON] (Response SetGameScoreResult))

setGameScore :: SetGameScoreRequest -> ClientM (Response SetGameScoreResult)

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. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

getGameHighScores

type GetGameHighScores = "getGameHighScores" :> (ReqBody '[JSON] GetGameHighScoresRequest :> Post '[JSON] (Response [GameHighScore]))