Hide

TurnBasedMatchConfig

public abstract class TurnBasedMatchConfig extends Object
java.lang.Object
   ↳ com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig

Configuration for creating a new turn-based match.

Nested Class Summary

class TurnBasedMatchConfig.Builder Builder class for TurnBasedMatchConfig

Protected Constructor Summary

Public Method Summary

static TurnBasedMatchConfig.Builder
static Bundle
createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask)
abstract Bundle
abstract String[]
abstract int

Protected Constructors

protected TurnBasedMatchConfig ()

Public Methods

public static TurnBasedMatchConfig.Builder builder ()

Creates a builder for assembling a TurnBasedMatchConfig.

Returns
  • An instance of a builder.

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

Creates an auto-match criteria Bundle. Can be passed to createMatch(GoogleApiClient, TurnBasedMatchConfig) to create a match for a turn-based game.

Parameters
minAutoMatchPlayers min number of auto-matched players.
maxAutoMatchPlayers max number of auto-matched players.
exclusiveBitMask exclusive bitmask for exclusive roles for the player. The exclusive bitmask of each pairing of players must equal zero for auto-match.
Returns
  • bundle of auto-match criteria data.

public abstract Bundle getAutoMatchCriteria ()

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

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

public abstract String[] getInvitedPlayerIds ()

Retrieves the player IDs to invite to the match.

Returns
  • The player IDs to invite to the match.

public abstract int getVariant ()

Retrieves the developer-specified match variant.

Returns
  • The developer-specified match variant.