C# Class PlayFab.PlayFabMatchmakerAPI

Enables the use of an external match-making service in conjunction with PlayFab hosted Game Server instances
Show file Open project: PlayFab/PlayFab-Samples

Public Methods

Method Description
AuthUser ( AuthUserRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void

Validates a user with the PlayFab service

PlayerJoined ( PlayerJoinedRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void

Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified

PlayerLeft ( PlayerLeftRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void

Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified

StartGame ( StartGameRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void

Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance

UserInfo ( UserInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void

Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches

Method Details

AuthUser() public static method

Validates a user with the PlayFab service
public static AuthUser ( AuthUserRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request PlayFab.MatchmakerModels.AuthUserRequest
resultCallback Action
errorCallback Action
customData object
return void

PlayerJoined() public static method

Informs the PlayFab game server hosting service that the indicated user has joined the Game Server Instance specified
public static PlayerJoined ( PlayerJoinedRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request PlayFab.MatchmakerModels.PlayerJoinedRequest
resultCallback Action
errorCallback Action
customData object
return void

PlayerLeft() public static method

Informs the PlayFab game server hosting service that the indicated user has left the Game Server Instance specified
public static PlayerLeft ( PlayerLeftRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request PlayFab.MatchmakerModels.PlayerLeftRequest
resultCallback Action
errorCallback Action
customData object
return void

StartGame() public static method

Instructs the PlayFab game server hosting service to instantiate a new Game Server Instance
public static StartGame ( StartGameRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request PlayFab.MatchmakerModels.StartGameRequest
resultCallback Action
errorCallback Action
customData object
return void

UserInfo() public static method

Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches
public static UserInfo ( UserInfoRequest request, Action resultCallback, Action errorCallback, object customData = null ) : void
request PlayFab.MatchmakerModels.UserInfoRequest
resultCallback Action
errorCallback Action
customData object
return void