java.lang.Object | |
↳ | com.google.android.gms.games.multiplayer.realtime.RoomConfig |
Configuration for a new room.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
RoomConfig.Builder | Builder class for RoomConfig . |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a builder for assembling a
RoomConfig . | |||||||||||
This method is deprecated.
use
builder(RoomUpdateCallback) instead.
| |||||||||||
Creates an auto-match criteria
Bundle for a new invitation. | |||||||||||
Retrieves the criteria for auto-matching one or more players for the room.
| |||||||||||
Retrieves the ID of the invitation to accept, if any.
| |||||||||||
Retrieves the player IDs to invite to the room.
| |||||||||||
This method is deprecated.
Use
getOnMessageReceivedListener() instead.
| |||||||||||
Returns the
OnRealTimeMessageReceivedListener that is called when the client has
received a message from a peer. | |||||||||||
Returns
RoomStatusUpdateCallback for the room status changes. | |||||||||||
This method is deprecated.
Use
getRoomStatusUpdateCallback() instead.
| |||||||||||
Returns
RoomUpdateCallback that is called when operations complete. | |||||||||||
This method is deprecated.
Use
getRoomUpdateCallback() instead.
| |||||||||||
Retrieves the (optional) developer-controlled parameter describing the type of game to play.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
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. |
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. |
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. |
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. |
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. |
Retrieves the player IDs to invite to the room.
Returns | |
---|---|
String[] |
The player IDs to invite to the room. |
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. |
Returns the OnRealTimeMessageReceivedListener
that is called when the client has
received a message from a peer.
Returns | |
---|---|
OnRealTimeMessageReceivedListener |
Returns RoomStatusUpdateCallback
for the room status changes.
Returns | |
---|---|
RoomStatusUpdateCallback |
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. |
Returns RoomUpdateCallback
that is called when operations complete.
Returns | |
---|---|
RoomUpdateCallback |
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. |
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. |