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]))
defSendGame :: ChatId -> Text -> SendGameRequest
defSetGameScore :: UserId -> Integer -> SetGameScoreRequest
defGetGameHighScores :: UserId -> GetGameHighScoresRequest

Types

`SendGameRequest`

data SendGameRequest Source #

Constructors

SendGameRequest

Fields

sendGameBusinessConnectionId :: Maybe BusinessConnectionId
Unique identifier of the business connection on behalf of which the message will be sent.
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.
sendGameMessageEffectId :: Maybe Text
Unique identifier of the message effect to be added to the message; for private chats only.
sendGameReplyToMessageId :: Maybe MessageId
If the message is a reply, ID of the original message.
sendGameReplyParameters :: Maybe ReplyParameters
Description of the message to reply to.
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

Instances details

FromJSON SendGameRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SendGameRequest #

parseJSONList :: Value -> Parser [SendGameRequest] #

omittedField :: Maybe 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 #

omitField :: SendGameRequest -> Bool #

Generic SendGameRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SendGameRequest

Instance details

Defined in Telegram.Bot.API.Games

Methods

from :: SendGameRequest -> Rep SendGameRequest x #

to :: Rep SendGameRequest x -> SendGameRequest #

Show SendGameRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SendGameRequest -> ShowS #

show :: SendGameRequest -> String #

showList :: [SendGameRequest] -> ShowS #

type Rep SendGameRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

`SetGameScoreRequest`

data SetGameScoreRequest Source #

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 InlineMessageId
Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

Instances details

FromJSON SetGameScoreRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SetGameScoreRequest #

parseJSONList :: Value -> Parser [SetGameScoreRequest] #

omittedField :: Maybe 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 #

omitField :: SetGameScoreRequest -> Bool #

Generic SetGameScoreRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SetGameScoreRequest

Instance details

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreRequest = D1 ('MetaData "SetGameScoreRequest" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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 InlineMessageId))))))

Methods

from :: SetGameScoreRequest -> Rep SetGameScoreRequest x #

to :: Rep SetGameScoreRequest x -> SetGameScoreRequest #

Show SetGameScoreRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SetGameScoreRequest -> ShowS #

show :: SetGameScoreRequest -> String #

showList :: [SetGameScoreRequest] -> ShowS #

type Rep SetGameScoreRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreRequest = D1 ('MetaData "SetGameScoreRequest" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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 InlineMessageId))))))

`SetGameScoreResult`

data SetGameScoreResult Source #

Constructors

SetGameScoreMessage Message
SetGameScoreMessageBool Bool

Instances

Instances details

FromJSON SetGameScoreResult Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

parseJSON :: Value -> Parser SetGameScoreResult #

parseJSONList :: Value -> Parser [SetGameScoreResult] #

omittedField :: Maybe 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 #

omitField :: SetGameScoreResult -> Bool #

Generic SetGameScoreResult Source #

Instance details

Defined in Telegram.Bot.API.Games

Associated Types

type Rep SetGameScoreResult

Instance details

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreResult = D1 ('MetaData "SetGameScoreResult" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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)))

Methods

from :: SetGameScoreResult -> Rep SetGameScoreResult x #

to :: Rep SetGameScoreResult x -> SetGameScoreResult #

Show SetGameScoreResult Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> SetGameScoreResult -> ShowS #

show :: SetGameScoreResult -> String #

showList :: [SetGameScoreResult] -> ShowS #

type Rep SetGameScoreResult Source #

Instance details

Defined in Telegram.Bot.API.Games

type Rep SetGameScoreResult = D1 ('MetaData "SetGameScoreResult" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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

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 InlineMessageId
Required if chat_id and message_id are not specified. Identifier of the inline message.

Instances

Instances details

Generic GetGameHighScoresRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Associated Types

type Rep GetGameHighScoresRequest

Instance details

Defined in Telegram.Bot.API.Games

type Rep GetGameHighScoresRequest = D1 ('MetaData "GetGameHighScoresRequest" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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 InlineMessageId)))))

Methods

from :: GetGameHighScoresRequest -> Rep GetGameHighScoresRequest x #

to :: Rep GetGameHighScoresRequest x -> GetGameHighScoresRequest #

Show GetGameHighScoresRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

Methods

showsPrec :: Int -> GetGameHighScoresRequest -> ShowS #

show :: GetGameHighScoresRequest -> String #

showList :: [GetGameHighScoresRequest] -> ShowS #

type Rep GetGameHighScoresRequest Source #

Instance details

Defined in Telegram.Bot.API.Games

type Rep GetGameHighScoresRequest = D1 ('MetaData "GetGameHighScoresRequest" "Telegram.Bot.API.Games" "telegram-bot-api-7.4.4-CbkblO6b3n86XenTUj4wdS" '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 InlineMessageId)))))

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 #

defSendGame :: ChatId -> Text -> SendGameRequest Source #

defSetGameScore :: UserId -> Integer -> SetGameScoreRequest Source #

defGetGameHighScores :: UserId -> GetGameHighScoresRequest Source #