My Project
Loading...
Searching...
No Matches
Public Attributes | List of all members
PlayFab.MultiplayerModels.CancelMatchmakingTicketRequest Class Reference

Only servers and ticket members can cancel a ticket. The ticket can be in five different states when it is cancelled. 1: the ticket is waiting for members to join it, and it has not started matching. If the ticket is cancelled at this stage, it will never match. 2: the ticket is matching. If the ticket is cancelled, it will stop matching. 3: the ticket is matched. A matched ticket cannot be cancelled. 4: the ticket is already cancelled and nothing happens. 5: the ticket is waiting for a server. If the ticket is cancelled, server allocation will be stopped. A server may still be allocated due to a race condition, but that will not be reflected in the ticket. There may be race conditions between the ticket getting matched and the client making a cancellation request. The client must handle the possibility that the cancel request fails if a match is found before the cancellation request is processed. We do not allow resubmitting a cancelled ticket because players must consent to enter matchmaking again. Create a new ticket instead. More...

Inheritance diagram for PlayFab.MultiplayerModels.CancelMatchmakingTicketRequest:
PlayFab.SharedModels.PlayFabRequestCommon PlayFab.SharedModels.PlayFabBaseModel

Public Attributes

Dictionary< string, string > CustomTags
 The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
 
string QueueName
 The name of the queue the ticket is in.
 
string TicketId
 The Id of the ticket to find a match for.
 
- Public Attributes inherited from PlayFab.SharedModels.PlayFabRequestCommon
PlayFabAuthenticationContext AuthenticationContext
 

Additional Inherited Members

- Public Member Functions inherited from PlayFab.SharedModels.PlayFabBaseModel
string ToJson ()
 

Detailed Description

Only servers and ticket members can cancel a ticket. The ticket can be in five different states when it is cancelled. 1: the ticket is waiting for members to join it, and it has not started matching. If the ticket is cancelled at this stage, it will never match. 2: the ticket is matching. If the ticket is cancelled, it will stop matching. 3: the ticket is matched. A matched ticket cannot be cancelled. 4: the ticket is already cancelled and nothing happens. 5: the ticket is waiting for a server. If the ticket is cancelled, server allocation will be stopped. A server may still be allocated due to a race condition, but that will not be reflected in the ticket. There may be race conditions between the ticket getting matched and the client making a cancellation request. The client must handle the possibility that the cancel request fails if a match is found before the cancellation request is processed. We do not allow resubmitting a cancelled ticket because players must consent to enter matchmaking again. Create a new ticket instead.


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