google_api_games v0.5.0 GoogleApi.Games.V1.Model.RoomStatus View Source

This is a JSON template for the status of a room that the player has joined.

Attributes

  • autoMatchingStatus (type: GoogleApi.Games.V1.Model.RoomAutoMatchStatus.t, default: nil) - Auto-matching status for this room. Not set if the room is not currently in the automatching queue.
  • kind (type: String.t, default: games#roomStatus) - Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus.
  • participants (type: list(GoogleApi.Games.V1.Model.RoomParticipant.t), default: nil) - The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.
  • roomId (type: String.t, default: nil) - Globally unique ID for a room.
  • status (type: String.t, default: nil) - The status of the room. Possible values are:

    • "ROOM_INVITING" - One or more players have been invited and not responded.
    • "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.
    • "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching).
    • "ROOM_ACTIVE" - All players have joined and connected to each other.
    • "ROOM_DELETED" - All joined players have left.
  • statusVersion (type: integer(), default: nil) - The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Games.V1.Model.RoomStatus{
  autoMatchingStatus: GoogleApi.Games.V1.Model.RoomAutoMatchStatus.t(),
  kind: String.t(),
  participants: [GoogleApi.Games.V1.Model.RoomParticipant.t()],
  roomId: String.t(),
  status: String.t(),
  statusVersion: integer()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.