My Project
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
PlayFab.PlayFabMultiplayerInstanceAPI Class Reference

API methods for managing multiplayer servers. API methods for managing parties. More...

Inheritance diagram for PlayFab.PlayFabMultiplayerInstanceAPI:
PlayFab.SharedModels.IPlayFabInstanceApi

Public Member Functions

 PlayFabMultiplayerInstanceAPI (PlayFabAuthenticationContext context)
 
 PlayFabMultiplayerInstanceAPI (PlayFabApiSettings settings, PlayFabAuthenticationContext context)
 
bool IsEntityLoggedIn ()
 Verify entity login.
 
void ForgetAllCredentials ()
 Clear the Client SessionToken which allows this Client to call API calls requiring login. A new/fresh login will be required after calling this.
 
void CancelAllMatchmakingTicketsForPlayer (CancelAllMatchmakingTicketsForPlayerRequest request, Action< CancelAllMatchmakingTicketsForPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Cancel all active tickets the player is a member of in a given queue.
 
void CancelAllServerBackfillTicketsForPlayer (CancelAllServerBackfillTicketsForPlayerRequest request, Action< CancelAllServerBackfillTicketsForPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Cancel all active backfill tickets the player is a member of in a given queue.
 
void CancelMatchmakingTicket (CancelMatchmakingTicketRequest request, Action< CancelMatchmakingTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Cancel a matchmaking ticket.
 
void CancelServerBackfillTicket (CancelServerBackfillTicketRequest request, Action< CancelServerBackfillTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Cancel a server backfill ticket.
 
void CreateBuildAlias (CreateBuildAliasRequest request, Action< BuildAliasDetailsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a multiplayer server build alias.
 
void CreateBuildWithCustomContainer (CreateBuildWithCustomContainerRequest request, Action< CreateBuildWithCustomContainerResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a multiplayer server build with a custom container.
 
void CreateBuildWithManagedContainer (CreateBuildWithManagedContainerRequest request, Action< CreateBuildWithManagedContainerResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a multiplayer server build with a managed container.
 
void CreateBuildWithProcessBasedServer (CreateBuildWithProcessBasedServerRequest request, Action< CreateBuildWithProcessBasedServerResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a multiplayer server build with the server running as a process.
 
void CreateMatchmakingTicket (CreateMatchmakingTicketRequest request, Action< CreateMatchmakingTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Create a matchmaking ticket as a client.
 
void CreateRemoteUser (CreateRemoteUserRequest request, Action< CreateRemoteUserResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a remote user to log on to a VM for a multiplayer server build.
 
void CreateServerBackfillTicket (CreateServerBackfillTicketRequest request, Action< CreateServerBackfillTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with other backfill tickets.
 
void CreateServerMatchmakingTicket (CreateServerMatchmakingTicketRequest request, Action< CreateMatchmakingTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other matchmaking tickets.
 
void CreateTitleMultiplayerServersQuotaChange (CreateTitleMultiplayerServersQuotaChangeRequest request, Action< CreateTitleMultiplayerServersQuotaChangeResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a request to change a title's multiplayer server quotas.
 
void DeleteAsset (DeleteAssetRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a multiplayer server game asset for a title.
 
void DeleteBuild (DeleteBuildRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a multiplayer server build.
 
void DeleteBuildAlias (DeleteBuildAliasRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a multiplayer server build alias.
 
void DeleteBuildRegion (DeleteBuildRegionRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Removes a multiplayer server build's region.
 
void DeleteCertificate (DeleteCertificateRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a multiplayer server game certificate.
 
void DeleteContainerImageRepository (DeleteContainerImageRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a container image repository.
 
void DeleteRemoteUser (DeleteRemoteUserRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Deletes a remote user to log on to a VM for a multiplayer server build.
 
void EnableMultiplayerServersForTitle (EnableMultiplayerServersForTitleRequest request, Action< EnableMultiplayerServersForTitleResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Enables the multiplayer server feature for a title.
 
void GetAssetDownloadUrl (GetAssetDownloadUrlRequest request, Action< GetAssetDownloadUrlResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets a URL that can be used to download the specified asset. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29.
 
void GetAssetUploadUrl (GetAssetUploadUrlRequest request, Action< GetAssetUploadUrlResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the URL to upload assets to. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29.
 
void GetBuild (GetBuildRequest request, Action< GetBuildResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets a multiplayer server build.
 
void GetBuildAlias (GetBuildAliasRequest request, Action< BuildAliasDetailsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets a multiplayer server build alias.
 
void GetContainerRegistryCredentials (GetContainerRegistryCredentialsRequest request, Action< GetContainerRegistryCredentialsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the credentials to the container registry.
 
void GetMatch (GetMatchRequest request, Action< GetMatchResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get a match.
 
void GetMatchmakingQueue (GetMatchmakingQueueRequest request, Action< GetMatchmakingQueueResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.
 
void GetMatchmakingTicket (GetMatchmakingTicketRequest request, Action< GetMatchmakingTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get a matchmaking ticket by ticket Id.
 
void GetMultiplayerServerDetails (GetMultiplayerServerDetailsRequest request, Action< GetMultiplayerServerDetailsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets multiplayer server session details for a build.
 
void GetMultiplayerServerLogs (GetMultiplayerServerLogsRequest request, Action< GetMultiplayerServerLogsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets multiplayer server logs after a server has terminated.
 
void GetMultiplayerSessionLogsBySessionId (GetMultiplayerSessionLogsBySessionIdRequest request, Action< GetMultiplayerServerLogsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets multiplayer server logs after a server has terminated.
 
void GetQueueStatistics (GetQueueStatisticsRequest request, Action< GetQueueStatisticsResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get the statistics for a queue.
 
void GetRemoteLoginEndpoint (GetRemoteLoginEndpointRequest request, Action< GetRemoteLoginEndpointResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets a remote login endpoint to a VM that is hosting a multiplayer server build.
 
void GetServerBackfillTicket (GetServerBackfillTicketRequest request, Action< GetServerBackfillTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Get a matchmaking backfill ticket by ticket Id.
 
void GetTitleEnabledForMultiplayerServersStatus (GetTitleEnabledForMultiplayerServersStatusRequest request, Action< GetTitleEnabledForMultiplayerServersStatusResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the status of whether a title is enabled for the multiplayer server feature.
 
void GetTitleMultiplayerServersQuotaChange (GetTitleMultiplayerServersQuotaChangeRequest request, Action< GetTitleMultiplayerServersQuotaChangeResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets a title's server quota change request.
 
void GetTitleMultiplayerServersQuotas (GetTitleMultiplayerServersQuotasRequest request, Action< GetTitleMultiplayerServersQuotasResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Gets the quotas for a title in relation to multiplayer servers.
 
void JoinMatchmakingTicket (JoinMatchmakingTicketRequest request, Action< JoinMatchmakingTicketResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Join a matchmaking ticket.
 
void ListArchivedMultiplayerServers (ListMultiplayerServersRequest request, Action< ListMultiplayerServersResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists archived multiplayer server sessions for a build.
 
void ListAssetSummaries (ListAssetSummariesRequest request, Action< ListAssetSummariesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists multiplayer server game assets for a title.
 
void ListBuildAliases (ListBuildAliasesRequest request, Action< ListBuildAliasesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.
 
void ListBuildSummariesV2 (ListBuildSummariesRequest request, Action< ListBuildSummariesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.
 
void ListCertificateSummaries (ListCertificateSummariesRequest request, Action< ListCertificateSummariesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists multiplayer server game certificates for a title.
 
void ListContainerImages (ListContainerImagesRequest request, Action< ListContainerImagesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists custom container images for a title.
 
void ListContainerImageTags (ListContainerImageTagsRequest request, Action< ListContainerImageTagsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists the tags for a custom container image.
 
void ListMatchmakingQueues (ListMatchmakingQueuesRequest request, Action< ListMatchmakingQueuesResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 SDK support is limited to C# and Java for this API. List all matchmaking queue configs.
 
void ListMatchmakingTicketsForPlayer (ListMatchmakingTicketsForPlayerRequest request, Action< ListMatchmakingTicketsForPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 List all matchmaking ticket Ids the user is a member of.
 
void ListMultiplayerServers (ListMultiplayerServersRequest request, Action< ListMultiplayerServersResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists multiplayer server sessions for a build.
 
void ListPartyQosServers (ListPartyQosServersRequest request, Action< ListPartyQosServersResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists quality of service servers for party.
 
void ListQosServersForTitle (ListQosServersForTitleRequest request, Action< ListQosServersForTitleResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.
 
void ListServerBackfillTicketsForPlayer (ListServerBackfillTicketsForPlayerRequest request, Action< ListServerBackfillTicketsForPlayerResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 List all server backfill ticket Ids the user is a member of.
 
void ListTitleMultiplayerServersQuotaChanges (ListTitleMultiplayerServersQuotaChangesRequest request, Action< ListTitleMultiplayerServersQuotaChangesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 List all server quota change requests for a title.
 
void ListVirtualMachineSummaries (ListVirtualMachineSummariesRequest request, Action< ListVirtualMachineSummariesResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Lists virtual machines for a title.
 
void RemoveMatchmakingQueue (RemoveMatchmakingQueueRequest request, Action< RemoveMatchmakingQueueResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.
 
void RequestMultiplayerServer (RequestMultiplayerServerRequest request, Action< RequestMultiplayerServerResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.
 
void RolloverContainerRegistryCredentials (RolloverContainerRegistryCredentialsRequest request, Action< RolloverContainerRegistryCredentialsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Rolls over the credentials to the container registry.
 
void SetMatchmakingQueue (SetMatchmakingQueueRequest request, Action< SetMatchmakingQueueResult > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.
 
void ShutdownMultiplayerServer (ShutdownMultiplayerServerRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Shuts down a multiplayer server session.
 
void UntagContainerImage (UntagContainerImageRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Untags a container image.
 
void UpdateBuildAlias (UpdateBuildAliasRequest request, Action< BuildAliasDetailsResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Creates a multiplayer server build alias.
 
void UpdateBuildName (UpdateBuildNameRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Updates a multiplayer server build's name.
 
void UpdateBuildRegion (UpdateBuildRegionRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Updates a multiplayer server build's region. If the region is not yet created, it will be created.
 
void UpdateBuildRegions (UpdateBuildRegionsRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Updates a multiplayer server build's regions.
 
void UploadCertificate (UploadCertificateRequest request, Action< EmptyResponse > resultCallback, Action< PlayFabError > errorCallback, object customData=null, Dictionary< string, string > extraHeaders=null)
 Uploads a multiplayer server game certificate.
 

Public Attributes

readonly PlayFabApiSettings apiSettings = null
 
readonly PlayFabAuthenticationContext authenticationContext = null
 

Detailed Description

API methods for managing multiplayer servers. API methods for managing parties.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6