License | MIT |
---|---|
Safe Haskell | None |
Language | Haskell2010 |
BattlePlace.WebApi.Types
Description
Synopsis
- newtype AccountId = AccountId Base64Word64
- newtype ProjectId = ProjectId Base64Word64
- data Auth
- = Auth_itchJwtToken { }
- | Auth_itchApiKey {
- auth_itchApiKey :: !Text
- | Auth_steamEncryptedTicket { }
- | Auth_testKey {
- auth_testKey :: !Text
- auth_testId :: !StrWord64
- data AuthType
- authTypeOf :: Auth -> AuthType
- data Client
- = Client_itch { }
- | Client_steam { }
- | Client_test { }
- data ClientType
- clientTypeOf :: Client -> ClientType
- newtype ProjectServerId = ProjectServerId Base64Word64
- newtype ProjectServerToken = ProjectServerToken Text
- newtype ProjectServerName = ProjectServerName Text
- type MatchTeamSize = Int
- newtype MatchTag = MatchTag Text
- newtype ServerTag = ServerTag Text
- newtype MatchPlayerInfo = MatchPlayerInfo Value
- newtype MatchServerInfo = MatchServerInfo Value
- data MatchToken = MatchToken {
- data MatchFailureReason
- data SessionToken = SessionToken {}
- newtype SessionId = SessionId Base64ByteString
- newtype ServerSessionToken = ServerSessionToken {}
- data MatchSession = MatchSession {}
- data MatchServerSession = MatchServerSession {}
- newtype MatchTeam = MatchTeam (Vector MatchPlayer)
- data MatchPlayer = MatchPlayer {}
- data MatchServer = MatchServer {}
- data UserStats = UserStats {
- userStats_rank :: !Int
- userStats_rating :: !Rating
- data Identified i a = Identified {
- identified_id :: !i
- identified_info :: !a
- newtype Base64ByteString = Base64ByteString ByteString
- newtype Base64Word64 = Base64Word64 Word64
- newtype StrWord64 = StrWord64 Word64
Documentation
Account id. At the moment it's just itch user id, but that may change.
Constructors
AccountId Base64Word64 |
Instances
ToJSON AccountId Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON AccountId Source # | |
FromHttpApiData AccountId Source # | |
Defined in BattlePlace.WebApi.Types Methods parseUrlPiece :: Text -> Either Text AccountId # parseHeader :: ByteString -> Either Text AccountId # |
Project id.
Constructors
ProjectId Base64Word64 |
Instances
Eq ProjectId Source # | |
Hashable ProjectId Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON ProjectId Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON ProjectId Source # | |
FromHttpApiData ProjectId Source # | |
Defined in BattlePlace.WebApi.Types Methods parseUrlPiece :: Text -> Either Text ProjectId # parseHeader :: ByteString -> Either Text ProjectId # |
Constructors
Auth_itchJwtToken | |
Fields | |
Auth_itchApiKey | |
Fields
| |
Auth_steamEncryptedTicket | |
Fields | |
Auth_testKey | |
Fields
|
Instances
Generic Auth Source # | |
ToJSON Auth Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON Auth Source # | |
type Rep Auth Source # | |
Defined in BattlePlace.WebApi.Types type Rep Auth = D1 (MetaData "Auth" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) ((C1 (MetaCons "Auth_itchJwtToken" PrefixI True) (S1 (MetaSel (Just "auth_itchJwtToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "Auth_itchApiKey" PrefixI True) (S1 (MetaSel (Just "auth_itchApiKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :+: (C1 (MetaCons "Auth_steamEncryptedTicket" PrefixI True) (S1 (MetaSel (Just "auth_steamEncryptedTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: C1 (MetaCons "Auth_testKey" PrefixI True) (S1 (MetaSel (Just "auth_testKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "auth_testId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 StrWord64)))) |
Auth type (for logging).
Constructors
AuthType_itchJwtToken | |
AuthType_itchApiKey | |
AuthType_steamEncryptedTicket | |
AuthType_testKey |
Instances
Eq AuthType Source # | |
Generic AuthType Source # | |
Hashable AuthType Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON AuthType Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON AuthType Source # | |
type Rep AuthType Source # | |
Defined in BattlePlace.WebApi.Types type Rep AuthType = D1 (MetaData "AuthType" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) ((C1 (MetaCons "AuthType_itchJwtToken" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AuthType_itchApiKey" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "AuthType_steamEncryptedTicket" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "AuthType_testKey" PrefixI False) (U1 :: * -> *))) |
authTypeOf :: Auth -> AuthType Source #
Constructors
Client_itch | |
Fields | |
Client_steam | |
Fields | |
Client_test | |
Fields |
Instances
Eq Client Source # | |
Generic Client Source # | |
Hashable Client Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON Client Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON Client Source # | |
type Rep Client Source # | |
Defined in BattlePlace.WebApi.Types type Rep Client = D1 (MetaData "Client" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "Client_itch" PrefixI True) (S1 (MetaSel (Just "client_itchUserId") SourceUnpack SourceStrict DecidedStrict) (Rec0 StrWord64)) :+: (C1 (MetaCons "Client_steam" PrefixI True) (S1 (MetaSel (Just "client_steamId") SourceUnpack SourceStrict DecidedStrict) (Rec0 StrWord64)) :+: C1 (MetaCons "Client_test" PrefixI True) (S1 (MetaSel (Just "client_testId") SourceUnpack SourceStrict DecidedStrict) (Rec0 StrWord64)))) |
data ClientType Source #
Type of the client. Must correspont to JSON field "type" of Client
.
Constructors
ClientType_itch | |
ClientType_steam | |
ClientType_test |
Instances
Eq ClientType Source # | |
Defined in BattlePlace.WebApi.Types | |
Generic ClientType Source # | |
Defined in BattlePlace.WebApi.Types Associated Types type Rep ClientType :: * -> * # | |
Hashable ClientType Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON ClientType Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: ClientType -> Value # toEncoding :: ClientType -> Encoding # toJSONList :: [ClientType] -> Value # toEncodingList :: [ClientType] -> Encoding # | |
FromJSON ClientType Source # | |
Defined in BattlePlace.WebApi.Types | |
type Rep ClientType Source # | |
Defined in BattlePlace.WebApi.Types type Rep ClientType = D1 (MetaData "ClientType" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "ClientType_itch" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ClientType_steam" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ClientType_test" PrefixI False) (U1 :: * -> *))) |
clientTypeOf :: Client -> ClientType Source #
newtype ProjectServerId Source #
Project's server id.
Constructors
ProjectServerId Base64Word64 |
Instances
Eq ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types Methods (==) :: ProjectServerId -> ProjectServerId -> Bool # (/=) :: ProjectServerId -> ProjectServerId -> Bool # | |
Hashable ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: ProjectServerId -> Value # toEncoding :: ProjectServerId -> Encoding # toJSONList :: [ProjectServerId] -> Value # toEncodingList :: [ProjectServerId] -> Encoding # | |
ToJSONKey ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types Methods parseJSON :: Value -> Parser ProjectServerId # parseJSONList :: Value -> Parser [ProjectServerId] # | |
FromJSONKey ProjectServerId Source # | |
Defined in BattlePlace.WebApi.Types |
newtype ProjectServerToken Source #
Project's secret server token.
Constructors
ProjectServerToken Text |
Instances
Eq ProjectServerToken Source # | |
Defined in BattlePlace.WebApi.Types Methods (==) :: ProjectServerToken -> ProjectServerToken -> Bool # (/=) :: ProjectServerToken -> ProjectServerToken -> Bool # | |
Hashable ProjectServerToken Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON ProjectServerToken Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: ProjectServerToken -> Value # toEncoding :: ProjectServerToken -> Encoding # toJSONList :: [ProjectServerToken] -> Value # toEncodingList :: [ProjectServerToken] -> Encoding # | |
FromJSON ProjectServerToken Source # | |
Defined in BattlePlace.WebApi.Types Methods parseJSON :: Value -> Parser ProjectServerToken # parseJSONList :: Value -> Parser [ProjectServerToken] # |
newtype ProjectServerName Source #
Project's server name.
Constructors
ProjectServerName Text |
Instances
Eq ProjectServerName Source # | |
Defined in BattlePlace.WebApi.Types Methods (==) :: ProjectServerName -> ProjectServerName -> Bool # (/=) :: ProjectServerName -> ProjectServerName -> Bool # | |
Hashable ProjectServerName Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON ProjectServerName Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: ProjectServerName -> Value # toEncoding :: ProjectServerName -> Encoding # toJSONList :: [ProjectServerName] -> Value # toEncodingList :: [ProjectServerName] -> Encoding # | |
FromJSON ProjectServerName Source # | |
Defined in BattlePlace.WebApi.Types Methods parseJSON :: Value -> Parser ProjectServerName # parseJSONList :: Value -> Parser [ProjectServerName] # |
type MatchTeamSize = Int Source #
Size of a team in match request.
Match tag in match request.
Server tag in match request.
newtype MatchPlayerInfo Source #
Opaque player info.
Constructors
MatchPlayerInfo Value |
Instances
ToJSON MatchPlayerInfo Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: MatchPlayerInfo -> Value # toEncoding :: MatchPlayerInfo -> Encoding # toJSONList :: [MatchPlayerInfo] -> Value # toEncodingList :: [MatchPlayerInfo] -> Encoding # | |
FromJSON MatchPlayerInfo Source # | |
Defined in BattlePlace.WebApi.Types Methods parseJSON :: Value -> Parser MatchPlayerInfo # parseJSONList :: Value -> Parser [MatchPlayerInfo] # |
newtype MatchServerInfo Source #
Opaque server info.
Constructors
MatchServerInfo Value |
Instances
ToJSON MatchServerInfo Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: MatchServerInfo -> Value # toEncoding :: MatchServerInfo -> Encoding # toJSONList :: [MatchServerInfo] -> Value # toEncodingList :: [MatchServerInfo] -> Encoding # | |
FromJSON MatchServerInfo Source # | |
Defined in BattlePlace.WebApi.Types Methods parseJSON :: Value -> Parser MatchServerInfo # parseJSONList :: Value -> Parser [MatchServerInfo] # |
data MatchToken Source #
Match token.
Constructors
MatchToken | |
Instances
Generic MatchToken Source # | |
Defined in BattlePlace.WebApi.Types Associated Types type Rep MatchToken :: * -> * # | |
ToJSON MatchToken Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: MatchToken -> Value # toEncoding :: MatchToken -> Encoding # toJSONList :: [MatchToken] -> Value # toEncodingList :: [MatchToken] -> Encoding # | |
FromJSON MatchToken Source # | |
Defined in BattlePlace.WebApi.Types | |
type Rep MatchToken Source # | |
data MatchFailureReason Source #
Reason of match failure.
Constructors
MatchFailureReason_timedOut | Failed to make a match in a specified time. |
MatchFailureReason_noServer | Match was made, but no server is available (and use of server is mandatory). |
MatchFailureReason_cancelled | Matching was explicitly cancelled by user. |
Instances
data SessionToken Source #
Session token.
Constructors
SessionToken | |
Fields |
Instances
Generic SessionToken Source # | |
Defined in BattlePlace.WebApi.Types Associated Types type Rep SessionToken :: * -> * # | |
ToJSON SessionToken Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: SessionToken -> Value # toEncoding :: SessionToken -> Encoding # toJSONList :: [SessionToken] -> Value # toEncodingList :: [SessionToken] -> Encoding # | |
FromJSON SessionToken Source # | |
Defined in BattlePlace.WebApi.Types | |
type Rep SessionToken Source # | |
Defined in BattlePlace.WebApi.Types type Rep SessionToken = D1 (MetaData "SessionToken" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "SessionToken" PrefixI True) (S1 (MetaSel (Just "sessionToken_sessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SessionId) :*: (S1 (MetaSel (Just "sessionToken_teamIndex") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "sessionToken_mateIndex") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int)))) |
Session id.
Constructors
SessionId Base64ByteString |
newtype ServerSessionToken Source #
Server session token.
Constructors
ServerSessionToken | |
Fields |
Instances
data MatchSession Source #
Match session.
Constructors
MatchSession | |
Fields |
Instances
data MatchServerSession Source #
Match server session.
Constructors
MatchServerSession | |
Instances
Match team.
Constructors
MatchTeam (Vector MatchPlayer) |
data MatchPlayer Source #
Match player.
Constructors
MatchPlayer | |
Fields |
Instances
Generic MatchPlayer Source # | |
Defined in BattlePlace.WebApi.Types Associated Types type Rep MatchPlayer :: * -> * # | |
ToJSON MatchPlayer Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: MatchPlayer -> Value # toEncoding :: MatchPlayer -> Encoding # toJSONList :: [MatchPlayer] -> Value # toEncodingList :: [MatchPlayer] -> Encoding # | |
FromJSON MatchPlayer Source # | |
Defined in BattlePlace.WebApi.Types | |
type Rep MatchPlayer Source # | |
Defined in BattlePlace.WebApi.Types type Rep MatchPlayer = D1 (MetaData "MatchPlayer" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "MatchPlayer" PrefixI True) (S1 (MetaSel (Just "matchPlayer_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 MatchPlayerInfo) :*: (S1 (MetaSel (Just "matchPlayer_ourTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Ticket)) :*: S1 (MetaSel (Just "matchPlayer_theirTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Ticket))))) |
data MatchServer Source #
Match server.
Constructors
MatchServer | |
Fields |
Instances
Generic MatchServer Source # | |
Defined in BattlePlace.WebApi.Types Associated Types type Rep MatchServer :: * -> * # | |
ToJSON MatchServer Source # | |
Defined in BattlePlace.WebApi.Types Methods toJSON :: MatchServer -> Value # toEncoding :: MatchServer -> Encoding # toJSONList :: [MatchServer] -> Value # toEncodingList :: [MatchServer] -> Encoding # | |
FromJSON MatchServer Source # | |
Defined in BattlePlace.WebApi.Types | |
type Rep MatchServer Source # | |
Defined in BattlePlace.WebApi.Types type Rep MatchServer = D1 (MetaData "MatchServer" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "MatchServer" PrefixI True) (S1 (MetaSel (Just "matchServer_info") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 MatchServerInfo) :*: (S1 (MetaSel (Just "matchServer_ourTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Ticket) :*: S1 (MetaSel (Just "matchServer_theirTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Ticket)))) |
User stats.
Constructors
UserStats | |
Fields
|
Instances
Generic UserStats Source # | |
ToJSON UserStats Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON UserStats Source # | |
type Rep UserStats Source # | |
Defined in BattlePlace.WebApi.Types type Rep UserStats = D1 (MetaData "UserStats" "BattlePlace.WebApi.Types" "battleplace-0.1.0.7-GzTbf17NQ257znzzAEUSPC" False) (C1 (MetaCons "UserStats" PrefixI True) (S1 (MetaSel (Just "userStats_rank") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "userStats_rating") SourceUnpack SourceStrict DecidedStrict) (Rec0 Rating))) |
data Identified i a Source #
Generic data type for id + object.
Constructors
Identified | |
Fields
|
Instances
newtype Base64ByteString Source #
ByteString which serializes to JSON as base64 string.
Constructors
Base64ByteString ByteString |
Instances
newtype Base64Word64 Source #
Word64 which serializes to JSON as base64 string. Useful because 64-bit integer is not representable in javascript.
Constructors
Base64Word64 Word64 |
Instances
Word64 which serializes to JSON as decimal string. Useful because 64-bit integer is not representable in javascript.
Instances
Eq StrWord64 Source # | |
Num StrWord64 Source # | |
Defined in BattlePlace.WebApi.Types | |
Ord StrWord64 Source # | |
Read StrWord64 Source # | |
Show StrWord64 Source # | |
Hashable StrWord64 Source # | |
Defined in BattlePlace.WebApi.Types | |
ToJSON StrWord64 Source # | |
Defined in BattlePlace.WebApi.Types | |
FromJSON StrWord64 Source # | |
Storable StrWord64 Source # | |
Defined in BattlePlace.WebApi.Types | |
Serialize StrWord64 Source # | |
FromHttpApiData StrWord64 Source # | |
Defined in BattlePlace.WebApi.Types Methods parseUrlPiece :: Text -> Either Text StrWord64 # parseHeader :: ByteString -> Either Text StrWord64 # |