| License | MIT |
|---|---|
| Safe Haskell | None |
| Language | Haskell2010 |
BattlePlace.WebApi.Types
Description
- 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
- type MatchTeamSize = Int
- newtype MatchTag = MatchTag Text
- newtype MatchPlayerInfo = MatchPlayerInfo Text
- data MatchToken = MatchToken {
- data MatchFailureReason
- data SessionToken = SessionToken {}
- newtype SessionId = SessionId Base64ByteString
- newtype ServerSessionToken = ServerSessionToken {}
- 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 |
Project id.
Constructors
| ProjectId Base64Word64 |
Constructors
| Auth_itchJwtToken | |
Fields | |
| Auth_itchApiKey | |
Fields
| |
| Auth_steamEncryptedTicket | |
Fields | |
| Auth_testKey | |
Fields
| |
Auth type (for logging).
authTypeOf :: Auth -> AuthType Source #
Constructors
| Client_itch | |
Fields | |
| Client_steam | |
Fields | |
| Client_test | |
Fields | |
data ClientType Source #
Type of the client. Must correspont to JSON field "type" of Client.
Constructors
| ClientType_itch | |
| ClientType_steam | |
| ClientType_test |
Instances
clientTypeOf :: Client -> ClientType Source #
newtype ProjectServerToken Source #
Project's secret server token.
Constructors
| ProjectServerToken Text |
type MatchTeamSize = Int Source #
Size of a team in match request.
Match tag in match request.
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. |
Session id.
Constructors
| SessionId Base64ByteString |
data Identified i a Source #
Generic data type for id + object.
Constructors
| Identified | |
Fields
| |
Instances
| Generic (Identified i a) Source # | |
| (ToJSON i, ToJSON a) => ToJSON (Identified i a) Source # | |
| (FromJSON i, FromJSON a) => FromJSON (Identified i a) Source # | |
| type Rep (Identified i a) Source # | |
newtype Base64ByteString Source #
ByteString which serializes to JSON as base64 string.
Constructors
| Base64ByteString ByteString |
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.