public final class

RoomConfig

extends Object
java.lang.Object
   ↳ com.google.android.gms.games.multiplayer.realtime.RoomConfig

Class Overview

Configuration for a new room.

Summary

Nested Classes
class RoomConfig.Builder Builder class for RoomConfig
Public Methods
static RoomConfig.Builder builder(RoomUpdateListener listener)
Creates a builder for assembling a RoomConfig.
static Bundle createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask)
Creates an auto-match criteria Bundle for a new invitation.
Bundle getAutoMatchCriteria()
Retrieves the criteria for auto-matching one or more players for the room.
String getInvitationId()
Retrieves the ID of the invitation to accept, if any.
String[] getInvitedPlayerIds()
Retrieves the player IDs to invite to the room.
RealTimeMessageReceivedListener getMessageReceivedListener()
Retrieves the listener for message received from a peer.
RoomStatusUpdateListener getRoomStatusUpdateListener()
Retrieves the listener for the room status changes.
RoomUpdateListener getRoomUpdateListener()
Retrieves the listener that is called when operations complete.
int getVariant()
Retrieves the (optional) developer-controlled parameter describing the type of game to play.
boolean isSocketEnabled()
Indicates whether to enable the use of sockets for sending/receiving data.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static RoomConfig.Builder builder (RoomUpdateListener listener)

Creates a builder for assembling a RoomConfig. The provided listener is required, and must not be null. It will be invoked on the main thread when appropriate.

Parameters
listener The listener to be invoked when the primary state of the room changes.
Returns
  • An instance of a builder.

public static Bundle createAutoMatchCriteria (int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask)

Creates an auto-match criteria Bundle for a new invitation. Can be passed to setAutoMatchCriteria(Bundle).

Parameters
minAutoMatchPlayers min number of auto-matched players.
maxAutoMatchPlayers max number of auto-matched players.
exclusiveBitMask exclusive bitmasks for the automatching request. The logical AND of each pairing of automatching requests must equal zero for auto-match. If there are no exclusivity requirements for the game, this value should just be set to 0.
Returns
  • bundle of auto-match criteria data.

public Bundle getAutoMatchCriteria ()

Retrieves the criteria for auto-matching one or more players for the room.

Returns
  • The criteria for auto-matching one or more players for the room.

public String getInvitationId ()

Retrieves the ID of the invitation to accept, if any. This is necessary when calling joinRoom(RoomConfig).

Returns
  • The ID of the invitation to accept.

public String[] getInvitedPlayerIds ()

Retrieves the player IDs to invite to the room.

Returns
  • The player IDs to invite to the room.

public RealTimeMessageReceivedListener getMessageReceivedListener ()

Retrieves the listener for message received from a peer.

Returns

public RoomStatusUpdateListener getRoomStatusUpdateListener ()

Retrieves the listener for the room status changes.

Returns

public RoomUpdateListener getRoomUpdateListener ()

Retrieves the listener that is called when operations complete.

Returns
  • The listener that is called when operations complete.

public int getVariant ()

Retrieves the (optional) developer-controlled parameter describing the type of game to play. Must be either a value from 1 to 1023 (inclusive), or ROOM_VARIANT_ANY if not desired.

Returns
  • The developer-specified game variant.

public boolean isSocketEnabled ()

Indicates whether to enable the use of sockets for sending/receiving data.

Returns
  • Whether to enable the use of sockets for sending/receiving data.