Summary: Nested Classes | Protected Ctors | Methods | Inherited Methods | [Expand All]
public abstract class

# TurnBasedMatchConfig

extends Object

java.lang.Object
↳ | com.google.android.gms.games.multiplayer.turnbased.TurnBasedMatchConfig

## Class Overview

Configuration for creating a new turn-based match.

## Summary

Nested Classes
class | TurnBasedMatchConfig.Builder | Builder class for `TurnBasedMatchConfig`.

Protected Constructors
| TurnBasedMatchConfig()

Public Methods
static TurnBasedMatchConfig.Builder | builder() Creates a builder for assembling a `TurnBasedMatchConfig`.
static Bundle | createAutoMatchCriteria(int minAutoMatchPlayers, int maxAutoMatchPlayers, long exclusiveBitMask) Creates an auto-match criteria `Bundle`.
abstract Bundle | getAutoMatchCriteria() Retrieves the criteria for auto-matching one or more players for the match.
abstract String[] | getInvitedPlayerIds() Retrieves the player IDs to invite to the match.
abstract int | getVariant() Retrieves the developer-specified match variant.

[Expand] Inherited Methods
From class java.lang.Object
Object | clone()
boolean | equals(Object arg0)
void | finalize()
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## 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.