google_api_games

v0.3.1

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

This is a JSON template for a room resource object.

Attributes

  • applicationId (String.t): The ID of the application being played. Defaults to: null.
  • autoMatchingCriteria (RoomAutoMatchingCriteria): Criteria for auto-matching players into this room. Defaults to: null.
  • autoMatchingStatus (RoomAutoMatchStatus): Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue. Defaults to: null.
  • creationDetails (RoomModification): Details about the room creation. Defaults to: null.
  • description (String.t): 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.) Defaults to: null.
  • inviterId (String.t): The ID of the participant that invited the user to the room. Not set if the user was not invited to the room. Defaults to: null.
  • kind (String.t): Uniquely identifies the type of this resource. Value is always the fixed string games#room. Defaults to: null.
  • lastUpdateDetails (RoomModification): Details about the last update to the room. 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.
  • roomStatusVersion (integer()): The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status. 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 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. Defaults to: null.
  • variant (integer()): The variant / mode of the application being played; can be any integer value, or left blank. Defaults to: null.

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

Link to this type

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