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

This is a JSON template for a room resource object.

Attributes

  • applicationId (type: String.t, default: nil) - The ID of the application being played.
  • autoMatchingCriteria (type: GoogleApi.Games.V1.Model.RoomAutoMatchingCriteria.t, default: nil) - Criteria for auto-matching players into this room.
  • 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 auto-matching queue.
  • creationDetails (type: GoogleApi.Games.V1.Model.RoomModification.t, default: nil) - Details about the room creation.
  • description (type: String.t, default: nil) - This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)
  • inviterId (type: String.t, default: nil) - The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.
  • kind (type: String.t, default: games#room) - Uniquely identifies the type of this resource. Value is always the fixed string games#room.
  • lastUpdateDetails (type: GoogleApi.Games.V1.Model.RoomModification.t, default: nil) - Details about the last update to the room.
  • 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.
  • roomStatusVersion (type: integer(), default: nil) - The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.
  • 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 and are connecting to each other (either before or after auto-matching).
    • "ROOM_ACTIVE" - All players have joined and connected to each other.
    • "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.
  • variant (type: integer(), default: nil) - The variant / mode of the application being played; can be any integer value, or left blank.

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.Room{
  applicationId: String.t(),
  autoMatchingCriteria: GoogleApi.Games.V1.Model.RoomAutoMatchingCriteria.t(),
  autoMatchingStatus: GoogleApi.Games.V1.Model.RoomAutoMatchStatus.t(),
  creationDetails: GoogleApi.Games.V1.Model.RoomModification.t(),
  description: String.t(),
  inviterId: String.t(),
  kind: String.t(),
  lastUpdateDetails: GoogleApi.Games.V1.Model.RoomModification.t(),
  participants: [GoogleApi.Games.V1.Model.RoomParticipant.t()],
  roomId: String.t(),
  roomStatusVersion: integer(),
  status: String.t(),
  variant: 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.