Class RoomParticipant
This is a JSON template for a participant in a room.
Inheritance
Implements
Namespace: Google.Apis.Games.v1.Data
Assembly: Google.Apis.Games.v1.dll
Syntax
public class RoomParticipant : object, IDirectResponseSchema
Properties
AutoMatched
True if this participant was auto-matched with the requesting player.
Declaration
public virtual Nullable<bool> AutoMatched { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
AutoMatchedPlayer
Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
Declaration
public virtual AnonymousPlayer AutoMatchedPlayer { get; set; }
Property Value
| Type | Description |
|---|---|
| AnonymousPlayer |
Capabilities
The capabilities which can be used when communicating with this participant.
Declaration
public virtual IList<string> Capabilities { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
ClientAddress
Client address for the participant.
Declaration
public virtual RoomClientAddress ClientAddress { get; set; }
Property Value
| Type | Description |
|---|---|
| RoomClientAddress |
Connected
True if this participant is in the fully connected set of peers in the room.
Declaration
public virtual Nullable<bool> Connected { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Id
An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
Declaration
public virtual string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Kind
Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
Declaration
public virtual string Kind { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
LeaveReason
The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT. Possible values are: - "PLAYER_LEFT" - The player explicitly chose to leave the room. - "GAME_LEFT" - The game chose to remove the player from the room. - "ABANDONED" - The player switched to another application and abandoned the room. - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room. - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server. - "TIMEOUT" - The client timed out while waiting for players to join and connect. - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.
Declaration
public virtual string LeaveReason { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Player
Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
Declaration
public virtual Player Player { get; set; }
Property Value
| Type | Description |
|---|---|
| Player |
Status
The status of the participant with respect to the room. Possible values are: - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded. - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.) - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room. - "PARTICIPANT_LEFT" - The participant joined the room and then left it.
Declaration
public virtual string Status { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |