MatchmakingTicket

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

Link copied to clipboard

Name of the matchmaking configuration 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.

Link copied to clipboard

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").

Link copied to clipboard

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.

Link copied to clipboard

Connection information for a new game session. Once a match is made, the FlexMatch engine creates a new game session for it. This information is added to the matchmaking ticket, which you can be retrieve by calling DescribeMatchmaking .

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Current status of the matchmaking request.

Link copied to clipboard

Additional information about the current status.

Link copied to clipboard

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.

Link copied to clipboard

A unique identifier for a matchmaking ticket.

Functions

Link copied to clipboard
inline fun copy(block: MatchmakingTicket.Builder.() -> Unit = {}): MatchmakingTicket
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String