Beamable SDK
Public Member Functions | Properties | Events | List of all members
Beamable.Experimental.Api.Matchmaking.MatchmakingHandle Class Reference

This type defines the MatchmakingHandle for the MatchmakingService. More...

Inheritance diagram for Beamable.Experimental.Api.Matchmaking.MatchmakingHandle:
Inheritance graph
[legend]
Collaboration diagram for Beamable.Experimental.Api.Matchmaking.MatchmakingHandle:
Collaboration graph
[legend]

Public Member Functions

 MatchmakingHandle (MatchmakingService service, IPlatformService platform, Ticket[] tickets, TimeSpan? maxWait=null, Action< MatchmakingHandle > onUpdate=null, Action< MatchmakingHandle > onMatchReady=null, Action< MatchmakingHandle > onMatchTimeout=null)
 
async void Dispose ()
 
Promise< MatchmakingHandleWhenCompleted ()
 Promise which will complete when the matchmaking client reaches a "resolution". More...
 
Promise< MatchmakingHandleCancel ()
 Cancels matchmaking for this player. More...
 

Properties

Ticket[] Tickets [get]
 
MatchmakingStatus Status [get]
 
MatchmakingState State [get]
 
Match Match [get]
 
bool MatchmakingIsComplete [get]
 

Events

Action< MatchmakingHandleOnUpdate
 
Action< MatchmakingHandleOnMatchReady
 
Action< MatchmakingHandleOnMatchTimeout
 

Detailed Description

This type defines the MatchmakingHandle for the MatchmakingService.

Related Links

img beamable-logo

Member Function Documentation

◆ Cancel()

Promise< MatchmakingHandle > Beamable.Experimental.Api.Matchmaking.MatchmakingHandle.Cancel ( )
inline

Cancels matchmaking for this player.

Returns
The MatchmakingHandle

◆ WhenCompleted()

Promise< MatchmakingHandle > Beamable.Experimental.Api.Matchmaking.MatchmakingHandle.WhenCompleted ( )
inline

Promise which will complete when the matchmaking client reaches a "resolution".

Returns
A promise containing the matchmaking handle itself.

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