google_api_games v0.8.0 GoogleApi.Games.V1.Model.TurnBasedMatchParticipant View Source

This is a JSON template for a participant in a turn-based match.

Attributes

autoMatched (type: boolean(), default: nil) - True if this participant was auto-matched with the requesting player.
autoMatchedPlayer (type: GoogleApi.Games.V1.Model.AnonymousPlayer.t, default: nil) - Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
id (type: String.t, default: nil) - An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts.
kind (type: String.t, default: games#turnBasedMatchParticipant) - Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant.
player (type: GoogleApi.Games.V1.Model.Player.t, default: nil) - Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
status (type: String.t, default: nil) - The status of the participant with respect to the match. Possible values are:
- "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn.
- "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded.
- "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.)
- "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match.
- "PARTICIPANT_LEFT" - The participant joined the match and then left it.
- "PARTICIPANT_FINISHED" - The participant finished playing in the match.
- "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

t() :: %GoogleApi.Games.V1.Model.TurnBasedMatchParticipant{
  autoMatched: boolean(),
  autoMatchedPlayer: GoogleApi.Games.V1.Model.AnonymousPlayer.t(),
  id: String.t(),
  kind: String.t(),
  player: GoogleApi.Games.V1.Model.Player.t(),
  status: String.t()
}

Link to this section Functions

decode(value, options)

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.