Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Games

Contents

Types
Methods

Synopsis

data SendGameRequest = SendGameRequest {
}
data SetGameScoreRequest = SetGameScoreRequest {
}
data SetGameScoreResult
- = SetGameScoreMessage Message
- | SetGameScoreMessageBool Bool
data GetGameHighScoresRequest = GetGameHighScoresRequest {
}
type SendGame = "sendGame" :> (ReqBody '[JSON] SendGameRequest :> Post '[JSON] (Response Message))
sendGame :: SendGameRequest -> ClientM (Response Message)
type SetGameScore = "setGameScore" :> (ReqBody '[JSON] SetGameScoreRequest :> Post '[JSON] (Response SetGameScoreResult))
setGameScore :: SetGameScoreRequest -> ClientM (Response SetGameScoreResult)
type GetGameHighScores = "getGameHighScores" :> (ReqBody '[JSON] GetGameHighScoresRequest :> Post '[JSON] (Response [GameHighScore]))

Types

`SendGameRequest`

data SendGameRequest Source #

Constructors

SendGameRequest

Fields

sendGameRequestChatId :: ChatId
Unique identifier for the target chat.
sendGameRequestGameShortName :: Text
Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.
sendGameRequestDisableNotification :: 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.
sendGameRequestReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendGameRequestAllowSendingWithoutReply :: Maybe Bool
Pass True, if the message should be sent even if the specified replied-to message is not found
sendGameRequestReplyMarkup :: 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

Instances details

Show SendGameRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods showsPrec :: Int -> SendGameRequest -> ShowS # show :: SendGameRequest -> String # showList :: [SendGameRequest] -> ShowS #
Generic SendGameRequest Source #
Instance details Defined in Telegram.Bot.API.Games Associated Types type Rep SendGameRequest :: Type -> Type # Methods from :: SendGameRequest -> Rep SendGameRequest x # to :: Rep SendGameRequest x -> SendGameRequest #
FromJSON SendGameRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods parseJSON :: Value -> Parser SendGameRequest parseJSONList :: Value -> Parser [SendGameRequest]
ToJSON SendGameRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods toJSON :: SendGameRequest -> Value toEncoding :: SendGameRequest -> Encoding toJSONList :: [SendGameRequest] -> Value toEncodingList :: [SendGameRequest] -> Encoding
type Rep SendGameRequest Source #
Instance details Defined in Telegram.Bot.API.Games type Rep SendGameRequest = D1 ('MetaData "SendGameRequest" "Telegram.Bot.API.Games" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SendGameRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sendGameRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChatId) :: (S1 ('MetaSel ('Just "sendGameRequestGameShortName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "sendGameRequestDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendGameProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendGameRequestReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :: (S1 ('MetaSel ('Just "sendGameRequestAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendGameRequestReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup))))))

`SetGameScoreRequest`

data SetGameScoreRequest Source #

Constructors

SetGameScoreRequest

Fields

setGameScoreRequestUserId :: UserId
User identifier.
setGameScoreRequestScore :: Integer
New score, must be non-negative.
setGameScoreRequestForce :: Maybe Bool
Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
setGameScoreRequestDisableEditMessage :: Maybe Bool
Pass True, if the game message should not be automatically edited to include the current scoreboard.
setGameScoreRequestChatId :: Maybe ChatId
Required if inline_message_id is not specified. Unique identifier for the target chat
setGameScoreRequestMessageId :: Maybe MessageId
Required if inline_message_id is not specified. Identifier of the sent message.
setGameScoreRequestInlineMessageId :: Maybe MessageId
Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

Instances details

Show SetGameScoreRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods showsPrec :: Int -> SetGameScoreRequest -> ShowS # show :: SetGameScoreRequest -> String # showList :: [SetGameScoreRequest] -> ShowS #
Generic SetGameScoreRequest Source #
Instance details Defined in Telegram.Bot.API.Games Associated Types type Rep SetGameScoreRequest :: Type -> Type # Methods from :: SetGameScoreRequest -> Rep SetGameScoreRequest x # to :: Rep SetGameScoreRequest x -> SetGameScoreRequest #
FromJSON SetGameScoreRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods parseJSON :: Value -> Parser SetGameScoreRequest parseJSONList :: Value -> Parser [SetGameScoreRequest]
ToJSON SetGameScoreRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods toJSON :: SetGameScoreRequest -> Value toEncoding :: SetGameScoreRequest -> Encoding toJSONList :: [SetGameScoreRequest] -> Value toEncodingList :: [SetGameScoreRequest] -> Encoding
type Rep SetGameScoreRequest Source #
Instance details Defined in Telegram.Bot.API.Games type Rep SetGameScoreRequest = D1 ('MetaData "SetGameScoreRequest" "Telegram.Bot.API.Games" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "SetGameScoreRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "setGameScoreRequestUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: (S1 ('MetaSel ('Just "setGameScoreRequestScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :: S1 ('MetaSel ('Just "setGameScoreRequestForce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "setGameScoreRequestDisableEditMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "setGameScoreRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId))) :: (S1 ('MetaSel ('Just "setGameScoreRequestMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :: S1 ('MetaSel ('Just "setGameScoreRequestInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))))))

`SetGameScoreResult`

data SetGameScoreResult Source #

Constructors

SetGameScoreMessage Message
SetGameScoreMessageBool Bool

Instances

Instances details

Show SetGameScoreResult Source #
Instance details Defined in Telegram.Bot.API.Games Methods showsPrec :: Int -> SetGameScoreResult -> ShowS # show :: SetGameScoreResult -> String # showList :: [SetGameScoreResult] -> ShowS #
Generic SetGameScoreResult Source #
Instance details Defined in Telegram.Bot.API.Games Associated Types type Rep SetGameScoreResult :: Type -> Type # Methods from :: SetGameScoreResult -> Rep SetGameScoreResult x # to :: Rep SetGameScoreResult x -> SetGameScoreResult #
FromJSON SetGameScoreResult Source #
Instance details Defined in Telegram.Bot.API.Games Methods parseJSON :: Value -> Parser SetGameScoreResult parseJSONList :: Value -> Parser [SetGameScoreResult]
ToJSON SetGameScoreResult Source #
Instance details Defined in Telegram.Bot.API.Games Methods toJSON :: SetGameScoreResult -> Value toEncoding :: SetGameScoreResult -> Encoding toJSONList :: [SetGameScoreResult] -> Value toEncodingList :: [SetGameScoreResult] -> Encoding
type Rep SetGameScoreResult Source #
Instance details Defined in Telegram.Bot.API.Games type Rep SetGameScoreResult = D1 ('MetaData "SetGameScoreResult" "Telegram.Bot.API.Games" "telegram-bot-simple-0.5.2-inplace" '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 Source #

Constructors

GetGameHighScoresRequest

Fields

getGameHighScoresRequestUserId :: UserId
Target user id.
getGameHighScoresRequestChatId :: Maybe ChatId
Required if inline_message_id is not specified. Unique identifier for the target chat.
getGameHighScoresRequestMessageId :: Maybe MessageId
Required if inline_message_id is not specified. Identifier of the sent message.
getGameHighScoresRequestInlineMessageId :: Maybe MessageId
Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

Instances details

Show GetGameHighScoresRequest Source #
Instance details Defined in Telegram.Bot.API.Games Methods showsPrec :: Int -> GetGameHighScoresRequest -> ShowS # show :: GetGameHighScoresRequest -> String # showList :: [GetGameHighScoresRequest] -> ShowS #
Generic GetGameHighScoresRequest Source #
Instance details Defined in Telegram.Bot.API.Games Associated Types type Rep GetGameHighScoresRequest :: Type -> Type # Methods from :: GetGameHighScoresRequest -> Rep GetGameHighScoresRequest x # to :: Rep GetGameHighScoresRequest x -> GetGameHighScoresRequest #
type Rep GetGameHighScoresRequest Source #
Instance details Defined in Telegram.Bot.API.Games type Rep GetGameHighScoresRequest = D1 ('MetaData "GetGameHighScoresRequest" "Telegram.Bot.API.Games" "telegram-bot-simple-0.5.2-inplace" 'False) (C1 ('MetaCons "GetGameHighScoresRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "getGameHighScoresRequestUserId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserId) :: S1 ('MetaSel ('Just "getGameHighScoresRequestChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ChatId))) :: (S1 ('MetaSel ('Just "getGameHighScoresRequestMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "getGameHighScoresRequestInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)))))

Methods

`sendGame`

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

sendGame :: SendGameRequest -> ClientM (Response Message) Source #

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)) Source #

setGameScore :: SetGameScoreRequest -> ClientM (Response SetGameScoreResult) Source #

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])) Source #