Skip to main content

GmSession

A runtime session: an isolated instance scope (e.g. a match or room) for containers.

type GmSession {
  sessionId: String!
  appId: BigInt!
  name: String
  status: String!
  createdByUserId: BigInt
  currentTurnUserId: BigInt
  metadataJson: String!
}

Fields​

GmSession.sessionId ● String! non-null scalar​

Unique session id.

GmSession.appId ● BigInt! non-null scalar​

The app (tenant) that owns the session.

GmSession.name ● String scalar​

Optional session name.

GmSession.status ● String! non-null scalar​

Lifecycle status (e.g. active).

GmSession.createdByUserId ● BigInt scalar​

The user who created the session.

GmSession.currentTurnUserId ● BigInt scalar​

The user whose turn it currently is (turn-based play), or null.

GmSession.metadataJson ● String! non-null scalar​

JSON object of developer metadata.

Returned By​

gameModelCreateSession mutation ● gameModelSession query ● gameModelSessions query ● gameModelSetSessionTurn mutation