AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.MatchmakingTicket

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public class MatchmakingTicket

The MatchmakingTicket type exposes the following members

Constructors

NameDescription
Public Method MatchmakingTicket()

Properties

NameTypeDescription
Public Property ConfigurationName System.String

Gets and sets the property ConfigurationName.

Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

Time stamp indicating when the matchmaking request stopped being processed due to successful completion, timeout, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Public Property EstimatedWaitTime System.Int32

Gets and sets the property EstimatedWaitTime.

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

Public Property GameSessionConnectionInfo Amazon.GameLift.Model.GameSessionConnectionInfo

Gets and sets the property GameSessionConnectionInfo.

Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.

Public Property Players System.Collections.Generic.List<Amazon.GameLift.Model.Player>

Gets and sets the property Players.

A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Public Property Status Amazon.GameLift.MatchmakingConfigurationStatus

Gets and sets the property Status.

Current status of the matchmaking request.

  • QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

  • SEARCHING -- The matchmaking request is currently being processed.

  • REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

  • PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

  • COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

  • FAILED -- The matchmaking request was not completed. Tickets with players who fail to accept a proposed match are placed in FAILED status; new matchmaking requests can be submitted for these players.

  • CANCELLED -- The matchmaking request was canceled with a call to StopMatchmaking.

  • TIMED_OUT -- The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

Additional information about the current status.

Public Property StatusReason System.String

Gets and sets the property StatusReason.

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

Public Property TicketId System.String

Gets and sets the property TicketId.

Unique identifier for a matchmaking ticket.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms