SWU Simulator SDK

Appearance

@my-swu/simulator-client

@my-swu/simulator-client / MatchHistoryEntry

Interface: MatchHistoryEntry ​

Defined in: packages/ts-sdk/src/generated/types/common.ts:4013

One match-history row returned to the SDK.

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

console.log(matchHistoryEntry)

Properties ​

completedAtMs? ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { completedAtMs } = matchHistoryEntry

console.log(completedAtMs)

optional completedAtMs?: number | null

Defined in: packages/ts-sdk/src/generated/types/common.ts:4014

createdAtMs ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { createdAtMs } = matchHistoryEntry

console.log(createdAtMs)

createdAtMs: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:4015

format ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { format } = matchHistoryEntry

console.log(format)

format: MatchFormat

Defined in: packages/ts-sdk/src/generated/types/common.ts:4016

historyId ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { historyId } = matchHistoryEntry

console.log(historyId)

historyId: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:4017

players ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { players } = matchHistoryEntry

console.log(players)

players: MatchHistoryPlayerSummary[]

Defined in: packages/ts-sdk/src/generated/types/common.ts:4018

replayAvailable ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { replayAvailable } = matchHistoryEntry

console.log(replayAvailable)

replayAvailable: boolean

Defined in: packages/ts-sdk/src/generated/types/common.ts:4022

Whether an authorized terminal replay archive is available.

restoreEligibility ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { restoreEligibility } = matchHistoryEntry

console.log(restoreEligibility)

restoreEligibility: HistoryRestoreEligibility

Defined in: packages/ts-sdk/src/generated/types/common.ts:4026

Versioned server policy deciding whether this row can be restored.

result? ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { result } = matchHistoryEntry

console.log(result)

optional result?: unknown

Defined in: packages/ts-sdk/src/generated/types/common.ts:4027

section ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { section } = matchHistoryEntry

console.log(section)

section: HistorySection

Defined in: packages/ts-sdk/src/generated/types/common.ts:4028

seed ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { seed } = matchHistoryEntry

console.log(seed)

seed: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:4029

series ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { series } = matchHistoryEntry

console.log(series)

series: unknown

Defined in: packages/ts-sdk/src/generated/types/common.ts:4030

sourceMatchId ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { sourceMatchId } = matchHistoryEntry

console.log(sourceMatchId)

sourceMatchId: string

Defined in: packages/ts-sdk/src/generated/types/common.ts:4031

status ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { status: healthStatus } = matchHistoryEntry

console.log(healthStatus)

status: HistoryStatus

Defined in: packages/ts-sdk/src/generated/types/common.ts:4032

updatedAtMs ​

Example:

ts
import type { MatchHistoryEntry } from '@my-swu/simulator-client'

const matchHistoryEntry: MatchHistoryEntry = {
  "historyId": 'example',
  "sourceMatchId": 'example',
  "section": "solo",
  "status": "saved",
  "format": "premier",
  "seed": 'example',
  "players": [],
  "series": {},
  "createdAtMs": 0,
  "updatedAtMs": 0,
  "restoreEligibility": {
    "kind": "available",
    "policyVersion": 0,
  },
  "replayAvailable": false,
}

const { updatedAtMs } = matchHistoryEntry

console.log(updatedAtMs)

updatedAtMs: number

Defined in: packages/ts-sdk/src/generated/types/common.ts:4033

Released under the MIT License.

Copyright © 2025-present Guillaume Chau