Current section

Files

Jump to
google_api_games lib google_api games v1 model room_status.ex
Raw

lib/google_api/games/v1/model/room_status.ex

# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This class is auto generated by the elixir code generator program.
# Do not edit the class manually.
defmodule GoogleApi.Games.V1.Model.RoomStatus do
@moduledoc """
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.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
:autoMatchingStatus => GoogleApi.Games.V1.Model.RoomAutoMatchStatus.t(),
:kind => String.t(),
:participants => list(GoogleApi.Games.V1.Model.RoomParticipant.t()),
:roomId => String.t(),
:status => String.t(),
:statusVersion => integer()
}
field(:autoMatchingStatus, as: GoogleApi.Games.V1.Model.RoomAutoMatchStatus)
field(:kind)
field(:participants, as: GoogleApi.Games.V1.Model.RoomParticipant, type: :list)
field(:roomId)
field(:status)
field(:statusVersion)
end
defimpl Poison.Decoder, for: GoogleApi.Games.V1.Model.RoomStatus do
def decode(value, options) do
GoogleApi.Games.V1.Model.RoomStatus.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Games.V1.Model.RoomStatus do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end