Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / LobbyMatchmakingRequest

Interface: LobbyMatchmakingRequest ​

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:195

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

console.log(lobbyMatchmakingRequest)

Properties ​

accountToken? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { accountToken } = lobbyMatchmakingRequest

console.log(accountToken)

optional accountToken?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:224

Optional verified account proof. When present and the selection is eligible, the server may silently place the player in a skill-based queue; a missing or invalid token always degrades to random pairing instead of failing.


authenticated ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { authenticated } = lobbyMatchmakingRequest

console.log(authenticated)

authenticated: boolean

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:203

Whether the player queued from an authenticated app session.


avatarUrl? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { avatarUrl } = lobbyMatchmakingRequest

console.log(avatarUrl)

optional avatarUrl?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:199

Public avatar image URL for the queued player.


config ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { config } = lobbyMatchmakingRequest

console.log(config)

config: LobbyMatchmakingConfig

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:196


deck ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { deck: lobbyMatchmakingRequestDeck } = lobbyMatchmakingRequest

console.log(lobbyMatchmakingRequestDeck)

deck: DeckInput

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:211

Deck the queued player brings to the pairing. Required: matchmaking has no later deck-submission step, so the server rejects a request without one.


deckId? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { deckId } = lobbyMatchmakingRequest

console.log(deckId)

optional deckId?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:217

Freeform client deck id for the submitted deck.


deckTitle? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { deckTitle } = lobbyMatchmakingRequest

console.log(deckTitle)

optional deckTitle?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:215

Display title for the submitted matchmaking deck.


formatSetup? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { formatSetup } = lobbyMatchmakingRequest

console.log(formatSetup)

optional formatSetup?: FormatSetupInput | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:213

Format-specific setup submitted with the matchmaking deck.


historyIdentities ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { historyIdentities } = lobbyMatchmakingRequest

console.log(historyIdentities)

historyIdentities: HistoryIdentityInput[]

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:205

Personal identities that should own this queued player's history.


name ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { name } = lobbyMatchmakingRequest

console.log(name)

name: string

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:197


profileUrl? ​

Example:

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

const lobbyMatchmakingRequest: LobbyMatchmakingRequest = {
  "config": {
    "mode": "duel",
    "format": "premier",
    "bestOfMatches": 1,
  },
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
  "deck": {
    "leaders": [],
    "cards": [],
    "sideboard": [],
  },
}

const { profileUrl } = lobbyMatchmakingRequest

console.log(profileUrl)

optional profileUrl?: string | null

Defined in: packages/ts-sdk/src/resources/lobby-types.ts:201

Public profile URL for the queued player.

Released under the MIT License.