MatchmakingTicket class
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.
Constructors
-
MatchmakingTicket({String? configurationArn, String? configurationName, DateTime? endTime, int? estimatedWaitTime, GameSessionConnectionInfo? gameSessionConnectionInfo, List<
Player> ? players, DateTime? startTime, MatchmakingConfigurationStatus? status, String? statusMessage, String? statusReason, String? ticketId}) -
MatchmakingTicket.fromJson(Map<
String, dynamic> json) -
factory
Properties
- configurationArn → String?
-
The Amazon Resource Name (ARN)
associated with the GameLift matchmaking configuration resource that is used
with this ticket.
final
- configurationName → String?
-
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.
final
- endTime → DateTime?
-
Time stamp indicating when this matchmaking request stopped being processed
due to success, failure, or cancellation. Format is a number expressed in
Unix time as milliseconds (for example "1469498468.057").
final
- estimatedWaitTime → int?
-
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.
final
- gameSessionConnectionInfo → 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. This parameter is not set when
FlexMatch is being used without GameLift hosting.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
players
→ List<
Player> ? -
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 statusCOMPLETED
, thePlayer
objects include the team the players were assigned to in the resulting match.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startTime → DateTime?
-
Time stamp indicating when this matchmaking request was received. Format is
a number expressed in Unix time as milliseconds (for example
"1469498468.057").
final
- status → MatchmakingConfigurationStatus?
-
Current status of the matchmaking request.
final
- statusMessage → String?
-
Additional information about the current status.
final
- statusReason → String?
-
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.final - ticketId → String?
-
A unique identifier for a matchmaking ticket.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited