public abstract 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
Protected Constructors
RoomConfig()
Public Methods
static RoomConfig.Builder builder(RoomUpdateCallback callback)
Creates a builder for assembling a RoomConfig.
static RoomConfig.Builder builder(RoomUpdateListener listener)
This method is deprecated. use builder(RoomUpdateCallback) instead.
static Bundle createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask)
Creates an auto-match criteria Bundle for a new invitation.
abstract Bundle getAutoMatchCriteria()
Retrieves the criteria for auto-matching one or more players for the room.
abstract String getInvitationId()
Retrieves the ID of the invitation to accept, if any.
abstract String[] getInvitedPlayerIds()
Retrieves the player IDs to invite to the room.
abstract RealTimeMessageReceivedListener getMessageReceivedListener()
This method is deprecated. Use getOnMessageReceivedListener() instead.
abstract OnRealTimeMessageReceivedListener getOnMessageReceivedListener()
Returns the OnRealTimeMessageReceivedListener that is called when the client has received a message from a peer.
abstract RoomStatusUpdateCallback getRoomStatusUpdateCallback()
Returns RoomStatusUpdateCallback for the room status changes.
abstract RoomStatusUpdateListener getRoomStatusUpdateListener()
This method is deprecated. Use getRoomStatusUpdateCallback() instead.
abstract RoomUpdateCallback getRoomUpdateCallback()
Returns RoomUpdateCallback that is called when operations complete.
abstract RoomUpdateListener getRoomUpdateListener()
This method is deprecated. Use getRoomUpdateCallback() instead.
abstract int getVariant()
Retrieves the (optional) developer-controlled parameter describing the type of game to play.
[Expand]
Inherited Methods
From class java.lang.Object

Protected Constructors

protected RoomConfig ()

Public Methods

public static RoomConfig.Builder builder (RoomUpdateCallback callback)

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
callback RoomUpdateCallback: The callback to be invoked when the primary state of the room changes.
Returns
RoomConfig.Builder An instance of a builder.

public static RoomConfig.Builder builder (RoomUpdateListener listener)

This method is deprecated.
use builder(RoomUpdateCallback) instead.

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 RoomUpdateListener: The listener to be invoked when the primary state of the room changes.
Returns
RoomConfig.Builder 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 int: Minimum number of auto-matched players.
maxAutoMatchPlayers int: Maximum number of auto-matched players.
exclusiveBitMask long: 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 A bundle of auto-match criteria data.

public abstract Bundle getAutoMatchCriteria ()

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

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

public abstract String getInvitationId ()

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

Returns
String The ID of the invitation to accept.

public abstract String[] getInvitedPlayerIds ()

Retrieves the player IDs to invite to the room.

Returns
String[] The player IDs to invite to the room.

public abstract RealTimeMessageReceivedListener getMessageReceivedListener ()

This method is deprecated.
Use getOnMessageReceivedListener() instead.

Retrieves the listener for message received from a peer.

Returns
RealTimeMessageReceivedListener The RealTimeMessageReceivedListener that is called when the client has received a message from a peer.

public abstract OnRealTimeMessageReceivedListener getOnMessageReceivedListener ()

Returns the OnRealTimeMessageReceivedListener that is called when the client has received a message from a peer.

Returns
OnRealTimeMessageReceivedListener

public abstract RoomStatusUpdateCallback getRoomStatusUpdateCallback ()

Returns RoomStatusUpdateCallback for the room status changes.

Returns
RoomStatusUpdateCallback

public abstract RoomStatusUpdateListener getRoomStatusUpdateListener ()

This method is deprecated.
Use getRoomStatusUpdateCallback() instead.

Retrieves the listener for the room status changes.

Returns
RoomStatusUpdateListener The RoomStatusUpdateListener that is called when the room status has changed.

public abstract RoomUpdateCallback getRoomUpdateCallback ()

Returns RoomUpdateCallback that is called when operations complete.

Returns
RoomUpdateCallback

public abstract RoomUpdateListener getRoomUpdateListener ()

This method is deprecated.
Use getRoomUpdateCallback() instead.

Retrieves the listener that is called when operations complete.

Returns
RoomUpdateListener The listener that is called when operations complete.

public abstract int getVariant ()

Retrieves the (optional) developer-controlled parameter describing the type of game to play. Must be either a positive integer or ROOM_VARIANT_DEFAULT if not desired.

Returns
int The developer-specified game variant.