Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribePlayerSessionsRequest

This data type is used to specify which player session(s) to retrieve. You can use it as follows:

  • Provide a PlayerSessionId to request a specific player session.
  • Provide a GameSessionId to request all player sessions in the specified game session.
  • Provide a PlayerId to request all player sessions for the specified player.

For large collections of player sessions, use the pagination parameters to retrieve results in sequential blocks.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly $type

$type: Type

Reference to the reflected type.

gameSessionId

gameSessionId: string

Unique game session identifier.

Use this parameter to request all player sessions for the specified game session. Game session ID format is as follows: arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>. The value of <ID string> is either a custom ID string or (if one was specified when the game session was created) a generated string.

limit

limit: number

Maximum number of results to return.

Use this parameter with nextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

nextToken

nextToken: string

Token indicating the start of the next sequential page of results.

Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

playerId

playerId: string

Unique identifier for a player.

Player IDs are defined by the developer. See Generating Player IDs.

playerSessionId

playerSessionId: string

Unique identifier for a player session.

playerSessionStatusFilter

playerSessionStatusFilter: "RESERVED" | "ACTIVE" | "COMPLETED" | "TIMEDOUT"

Player session status to filter results on.

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 time-out limit (60 seconds).

Static Readonly $type

$type: Type

Reference to the reflected type.

Methods

toJSON

  • toJSON(): {}

  • Converts this message to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

  • create<T>(this: Constructor<T>, properties?: {}): Message<T>

  • Creates a new message of this type using the specified properties.

    Type parameters

    Parameters

    • this: Constructor<T>
    • Optional properties: {}
      • [k: string]: any

    Returns Message<T>

    Message instance

Static decode

  • decode<T>(this: Constructor<T>, reader: Uint8Array | Reader): T

  • Decodes a message of this type.

    Type parameters

    Parameters

    • this: Constructor<T>
    • reader: Uint8Array | Reader

      Reader or buffer to decode

    Returns T

    Decoded message

Static decodeDelimited

  • decodeDelimited<T>(this: Constructor<T>, reader: Uint8Array | Reader): T

  • Decodes a message of this type preceeded by its length as a varint.

    Type parameters

    Parameters

    • this: Constructor<T>
    • reader: Uint8Array | Reader

      Reader or buffer to decode

    Returns T

    Decoded message

Static encode

  • encode<T>(this: Constructor<T>, message: T | {}, writer?: Writer): Writer

  • Encodes a message of this type.

    Type parameters

    Parameters

    • this: Constructor<T>
    • message: T | {}

      Message to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited<T>(this: Constructor<T>, message: T | {}, writer?: Writer): Writer

  • Encodes a message of this type preceeded by its length as a varint.

    Type parameters

    Parameters

    • this: Constructor<T>
    • message: T | {}

      Message to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

  • fromObject<T>(this: Constructor<T>, object: {}): T

  • Creates a new message of this type from a plain object. Also converts values to their respective internal types.

    Type parameters

    Parameters

    • this: Constructor<T>
    • object: {}

      Plain object

      • [k: string]: any

    Returns T

    Message instance

Static toObject

  • toObject<T>(this: Constructor<T>, message: T, options?: IConversionOptions): {}

  • Creates a plain object from a message of this type. Also converts values to other types if specified.

    Type parameters

    Parameters

    • this: Constructor<T>
    • message: T

      Message instance

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a message of this type.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc