GameSession class

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

Constructors

GameSession.new({DateTime? creationTime, String? creatorId, int? currentPlayerSessionCount, String? dnsName, String? fleetArn, String? fleetId, List<GameProperty>? gameProperties, String? gameSessionData, String? gameSessionId, String? ipAddress, String? matchmakerData, int? maximumPlayerSessionCount, String? name, PlayerSessionCreationPolicy? playerSessionCreationPolicy, int? port, GameSessionStatus? status, GameSessionStatusReason? statusReason, DateTime? terminationTime})
GameSession.fromJson(Map<String, dynamic> json)
factory

Properties

creationTime → DateTime?
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
final
creatorId → String?
A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
final
currentPlayerSessionCount → int?
Number of players currently in the game session.
final
dnsName → String?
DNS identifier assigned to the instance that is running the game session. Values have the following format:
final
fleetArn → String?
The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.
final
fleetId → String?
A unique identifier for a fleet that the game session is running on.
final
gameProperties → List<GameProperty>?
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.
final
gameSessionData → String?
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
final
gameSessionId → String?
A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.
final
hashCode → int
The hash code for this object.
no setterinherited
ipAddress → String?
IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a client needs to reference an IP address (or DNS name) and port number.
final
matchmakerData → String?
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).
final
maximumPlayerSessionCount → int?
The maximum number of players that can be connected simultaneously to the game session.
final
name → String?
A descriptive label that is associated with a game session. Session names do not need to be unique.
final
playerSessionCreationPolicy → PlayerSessionCreationPolicy?
Indicates whether or not the game session is accepting new players.
final
port → int?
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → GameSessionStatus?
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
final
statusReason → GameSessionStatusReason?
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
final
terminationTime → DateTime?
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
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