Beamable.Experimental.Api.Matchmaking.MatchmakingService Class Reference

This type defines the Client main entry point for the Multiplayer feature. More...

Public Member Functions
	MatchmakingService (IPlatformService platform, IBeamableRequester requester)
Promise< MatchmakingHandle >	StartMatchmaking (ContentRef< SimGameType > gameTypeRef, Action< MatchmakingHandle > updateHandler=null, Action< MatchmakingHandle > readyHandler=null, Action< MatchmakingHandle > timeoutHandler=null)
	Initialize the matchmaking process. More...
Promise< MatchmakingHandle >	StartMatchmaking (string gameType, Action< MatchmakingHandle > updateHandler=null, Action< MatchmakingHandle > readyHandler=null, Action< MatchmakingHandle > timeoutHandler=null, TimeSpan? maxWait=null)
	Initialize the matchmaking process. More...
Promise< Match >	GetMatch (string matchId)
	Fetch a match given its Id. More...
Promise< Unit >	CancelMatchmaking (string ticketId)
	Cancels matchmaking for the player More...

Detailed Description

This type defines the Client main entry point for the Multiplayer feature.

Related Links

• See the Multiplayer feature documentation
• See Beamable.API script reference

Member Function Documentation

CancelMatchmaking()

Promise< Unit > Beamable.Experimental.Api.Matchmaking.MatchmakingService.CancelMatchmaking ( string  ticketId )

inline

Cancels matchmaking for the player

Parameters

ticketId

The id of the ticket to cancel.

GetMatch()

Promise< Match > Beamable.Experimental.Api.Matchmaking.MatchmakingService.GetMatch ( string  matchId )

inline

Fetch a match given its Id.

Parameters

matchId

The id of the match to fetch.

StartMatchmaking() [1/2]

Promise< MatchmakingHandle > Beamable.Experimental.Api.Matchmaking.MatchmakingService.StartMatchmaking ( ContentRef< SimGameType >  gameTypeRef, Action< MatchmakingHandle >  updateHandler = null, Action< MatchmakingHandle >  readyHandler = null, Action< MatchmakingHandle >  timeoutHandler = null  )

inline

Initialize the matchmaking process.

Parameters

gameTypeRef
updateHandler
readyHandler
timeoutHandler

Returns

A MatchmakingHandle which will be updated via push notifications.

StartMatchmaking() [2/2]

Promise< MatchmakingHandle > Beamable.Experimental.Api.Matchmaking.MatchmakingService.StartMatchmaking ( string  gameType, Action< MatchmakingHandle >  updateHandler = null, Action< MatchmakingHandle >  readyHandler = null, Action< MatchmakingHandle >  timeoutHandler = null, TimeSpan?  maxWait = null  )

inline

Initialize the matchmaking process.

Parameters

gameType
updateHandler
readyHandler
timeoutHandler
maxWait

Returns

A MatchmakingHandle which will be updated via push notifications.

---

The documentation for this class was generated from the following file:

• com.beamable/Runtime/Core/Platform/SDK/Matchmaking/MatchmakingService.cs