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.

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

Player-session-related operations include:

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.PlayerSession

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

Syntax

C#
public class PlayerSession

The PlayerSession type exposes the following members

Constructors

NameDescription
Public Method PlayerSession()

Properties

NameTypeDescription
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet that the player's game session is running on.

Public Property GameSessionId System.String

Gets and sets the property GameSessionId.

Unique identifier for the game session that the player session is connected to.

Public Property IpAddress System.String

Gets and sets the property IpAddress.

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

Public Property PlayerData System.String

Gets and sets the property PlayerData.

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

Public Property PlayerId System.String

Gets and sets the property PlayerId.

Unique identifier for a player that is associated with this player session.

Public Property PlayerSessionId System.String

Gets and sets the property PlayerSessionId.

Unique identifier for a player session.

Public Property Port System.Int32

Gets and sets the property Port.

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

Public Property Status Amazon.GameLift.PlayerSessionStatus

Gets and sets the property Status.

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

Public Property TerminationTime System.DateTime

Gets and sets the property TerminationTime.

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

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