Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / MatchHistoryRestoreInput

Interface: MatchHistoryRestoreInput ​

Defined in: packages/ts-sdk/src/resources/match-history.ts:25

Request used to restore a server-side history entry into a fresh match.

Example:

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

// Identities prove the caller owns the history row being restored.
const matchHistoryRestoreInput: MatchHistoryRestoreInput = {
  historyId: '2f8b2c1e-0f2a-4b53-9f0f-6b4f1f3a9c11',
  identities: [{ kind: 'browser', key: 'browser-identity-key' }],
  restoreRequestId: '73266d86-45c5-43bb-bc6c-571d47326d64',
}

console.log(matchHistoryRestoreInput)

Extends ​

Properties ​

historyId ​

Example:

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

// Identities prove the caller owns the history row being restored.
const matchHistoryRestoreInput: MatchHistoryRestoreInput = {
  historyId: '2f8b2c1e-0f2a-4b53-9f0f-6b4f1f3a9c11',
  identities: [{ kind: 'browser', key: 'browser-identity-key' }],
  restoreRequestId: '73266d86-45c5-43bb-bc6c-571d47326d64',
}

const { historyId } = matchHistoryRestoreInput

console.log(historyId)

historyId: string

Defined in: packages/ts-sdk/src/resources/match-history.ts:29

Durable history row id returned by MatchHistoryResource.list.


identities ​

Example:

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

// Identities prove the caller owns the history row being restored.
const matchHistoryRestoreInput: MatchHistoryRestoreInput = {
  historyId: '2f8b2c1e-0f2a-4b53-9f0f-6b4f1f3a9c11',
  identities: [{ kind: 'browser', key: 'browser-identity-key' }],
  restoreRequestId: '73266d86-45c5-43bb-bc6c-571d47326d64',
}

const { identities } = matchHistoryRestoreInput

console.log(identities)

identities: HistoryIdentityInput[]

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

Inherited from ​

MatchHistoryRestoreRequest.identities


restoreRequestId ​

Example:

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

// Identities prove the caller owns the history row being restored.
const matchHistoryRestoreInput: MatchHistoryRestoreInput = {
  historyId: '2f8b2c1e-0f2a-4b53-9f0f-6b4f1f3a9c11',
  identities: [{ kind: 'browser', key: 'browser-identity-key' }],
  restoreRequestId: '73266d86-45c5-43bb-bc6c-571d47326d64',
}

const { restoreRequestId } = matchHistoryRestoreInput

console.log(restoreRequestId)

restoreRequestId: string

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

Stable browser-generated operation id used to make retries idempotent.

Inherited from ​

MatchHistoryRestoreRequest.restoreRequestId

Released under the MIT License.