public static final class

TurnBasedMatchConfig.Builder

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

Class Overview

Builder class for TurnBasedMatchConfig.

Summary

Public Methods
TurnBasedMatchConfig.Builder addInvitedPlayer(String playerId)
Add a player ID to invite to the match.
TurnBasedMatchConfig.Builder addInvitedPlayers(ArrayList<String> playerIds)
Add a list of player IDs to invite to the match.
TurnBasedMatchConfig build()
Builds a new TurnBasedMatchConfig object.
TurnBasedMatchConfig.Builder setAutoMatchCriteria(Bundle autoMatchCriteria)
Sets the auto-match criteria for the match.
TurnBasedMatchConfig.Builder setVariant(int variant)
Sets the variant for the match.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public TurnBasedMatchConfig.Builder addInvitedPlayer (String playerId)

Add a player ID to invite to the match.

Parameters
playerId Player ID to invite to the match.
Returns
  • The builder instance.

public TurnBasedMatchConfig.Builder addInvitedPlayers (ArrayList<String> playerIds)

Add a list of player IDs to invite to the match.

Parameters
playerIds One or more player IDs to invite to the match.
Returns
  • The builder instance.

public TurnBasedMatchConfig build ()

Builds a new TurnBasedMatchConfig object.

Returns

public TurnBasedMatchConfig.Builder setAutoMatchCriteria (Bundle autoMatchCriteria)

Sets the auto-match criteria for the match. See createAutoMatchCriteria(int, int, long).

Parameters
autoMatchCriteria The criteria for auto-matching one or more players for the match. If null, the match is created with the invited players only.
Returns
  • The builder instance.

public TurnBasedMatchConfig.Builder setVariant (int variant)

Sets the variant for the match. This is an optional, developer-controlled parameter describing the type of game to play, and is used for auto-matching criteria. Must be either a positive integer, or MATCH_VARIANT_DEFAULT (the default) if not desired.

Note that variants must match exactly. Thus, if you do not specify a variant, only other matches created with MATCH_VARIANT_DEFAULT will be considered potential auto-matches.

Parameters
variant The variant for the match.
Returns
  • The builder instance.