google_api_games v0.3.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 (RoomAutoMatchStatus): Auto-matching status for this room. Not set if the room is not currently in the automatching queue. Defaults to: null.
  • kind (String.t): Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus. Defaults to: null.
  • participants ([RoomParticipant]): The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations. Defaults to: null.
  • roomId (String.t): Globally unique ID for a room. Defaults to: null.
  • status (String.t): 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. Defaults to: null.
  • statusVersion (integer()): The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status. Defaults to: null.

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: any(),
  participants: [GoogleApi.Games.V1.Model.RoomParticipant.t()],
  roomId: any(),
  status: any(),
  statusVersion: any()
}

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.