RoomParticipant (Google Play Game Services API v1 (Rev. 359) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.games.model.RoomParticipant

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class RoomParticipant
extends com.google.api.client.json.GenericJson
```
This is a JSON template for a participant in a room.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play Game Services API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

RoomParticipant()

Constructors
Constructor and Description
`RoomParticipant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RoomParticipant`	`clone()`
`java.lang.Boolean`	`getAutoMatched()` True if this participant was auto-matched with the requesting player.
`AnonymousPlayer`	`getAutoMatchedPlayer()` Information about a player that has been anonymously auto-matched against the requesting player.
`java.util.List<java.lang.String>`	`getCapabilities()` The capabilities which can be used when communicating with this participant.
`RoomClientAddress`	`getClientAddress()` Client address for the participant.
`java.lang.Boolean`	`getConnected()` True if this participant is in the fully connected set of peers in the room.
`java.lang.String`	`getId()` An identifier for the participant in the scope of the room.
`java.lang.String`	`getKind()` Uniquely identifies the type of this resource.
`java.lang.String`	`getLeaveReason()` The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
`Player`	`getPlayer()` Information about the player.
`java.lang.String`	`getStatus()` The status of the participant with respect to the room.
`RoomParticipant`	`set(java.lang.String fieldName, java.lang.Object value)`
`RoomParticipant`	`setAutoMatched(java.lang.Boolean autoMatched)` True if this participant was auto-matched with the requesting player.
`RoomParticipant`	`setAutoMatchedPlayer(AnonymousPlayer autoMatchedPlayer)` Information about a player that has been anonymously auto-matched against the requesting player.
`RoomParticipant`	`setCapabilities(java.util.List<java.lang.String> capabilities)` The capabilities which can be used when communicating with this participant.
`RoomParticipant`	`setClientAddress(RoomClientAddress clientAddress)` Client address for the participant.
`RoomParticipant`	`setConnected(java.lang.Boolean connected)` True if this participant is in the fully connected set of peers in the room.
`RoomParticipant`	`setId(java.lang.String id)` An identifier for the participant in the scope of the room.
`RoomParticipant`	`setKind(java.lang.String kind)` Uniquely identifies the type of this resource.
`RoomParticipant`	`setLeaveReason(java.lang.String leaveReason)` The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.
`RoomParticipant`	`setPlayer(Player player)` Information about the player.
`RoomParticipant`	`setStatus(java.lang.String status)` The status of the participant with respect to the room.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - RoomParticipant
```
public RoomParticipant()
```
- Method Detail
  - getAutoMatched
```
public java.lang.Boolean getAutoMatched()
```
    True if this participant was auto-matched with the requesting player.
    
    Returns:
    
    value or null for none
  - setAutoMatched
```
public RoomParticipant setAutoMatched(java.lang.Boolean autoMatched)
```
    True if this participant was auto-matched with the requesting player.
    
    Parameters:
    
    autoMatched - autoMatched or null for none
  - getAutoMatchedPlayer
```
public AnonymousPlayer getAutoMatchedPlayer()
```
    Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
    
    Returns:
    
    value or null for none
  - setAutoMatchedPlayer
```
public RoomParticipant setAutoMatchedPlayer(AnonymousPlayer autoMatchedPlayer)
```
    Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
    
    Parameters:
    
    autoMatchedPlayer - autoMatchedPlayer or null for none
  - getCapabilities
```
public java.util.List<java.lang.String> getCapabilities()
```
    The capabilities which can be used when communicating with this participant.
    
    Returns:
    
    value or null for none
  - setCapabilities
```
public RoomParticipant setCapabilities(java.util.List<java.lang.String> capabilities)
```
    The capabilities which can be used when communicating with this participant.
    
    Parameters:
    
    capabilities - capabilities or null for none
  - getClientAddress
```
public RoomClientAddress getClientAddress()
```
    Client address for the participant.
    
    Returns:
    
    value or null for none
  - setClientAddress
```
public RoomParticipant setClientAddress(RoomClientAddress clientAddress)
```
    Client address for the participant.
    
    Parameters:
    
    clientAddress - clientAddress or null for none
  - getConnected
```
public java.lang.Boolean getConnected()
```
    True if this participant is in the fully connected set of peers in the room.
    
    Returns:
    
    value or null for none
  - setConnected
```
public RoomParticipant setConnected(java.lang.Boolean connected)
```
    True if this participant is in the fully connected set of peers in the room.
    
    Parameters:
    
    connected - connected or null for none
  - getId
```
public java.lang.String getId()
```
    An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.
    
    Returns:
    
    value or null for none
  - setId
```
public RoomParticipant setId(java.lang.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.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
    
    Returns:
    
    value or null for none
  - setKind
```
public RoomParticipant setKind(java.lang.String kind)
```
    Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.
    
    Parameters:
    
    kind - kind or null for none
  - getLeaveReason
```
public java.lang.String getLeaveReason()
```
    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.
    
    Returns:
    
    value or null for none
  - setLeaveReason
```
public RoomParticipant setLeaveReason(java.lang.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.
    
    Parameters:
    
    leaveReason - leaveReason or null for none
  - getPlayer
```
public Player getPlayer()
```
    Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.)
    
    Returns:
    
    value or null for none
  - setPlayer
```
public RoomParticipant setPlayer(Player 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.)
    
    Parameters:
    
    player - player or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    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.
    
    Returns:
    
    value or null for none
  - setStatus
```
public RoomParticipant setStatus(java.lang.String 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.
    
    Parameters:
    
    status - status or null for none
  - set
```
public RoomParticipant set(java.lang.String fieldName,
                           java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public RoomParticipant clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Google Play Game Services API v1 (revision 359)

Class RoomParticipant

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

RoomParticipant

Method Detail

getAutoMatched

setAutoMatched

getAutoMatchedPlayer

setAutoMatchedPlayer

getCapabilities

setCapabilities

getClientAddress

setClientAddress

getConnected

setConnected

getId

setId

getKind

setKind

getLeaveReason

setLeaveReason

getPlayer

setPlayer

getStatus

setStatus

set

clone