@my-swu/simulator-client

---

@my-swu/simulator-client / JoinMatchRequest

Interface: JoinMatchRequest

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

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

console.log(joinMatchRequest)

Properties

authenticated

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { authenticated } = joinMatchRequest

console.log(authenticated)

authenticated: boolean

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

Whether this player joined from an authenticated app session.

---

avatarUrl?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { avatarUrl } = joinMatchRequest

console.log(avatarUrl)

optional avatarUrl?: string | null

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

Optional public avatar image URL for this joining seat.

---

deck?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { deck: premierGuestDeckInput } = joinMatchRequest

console.log(premierGuestDeckInput)

optional deck?: DeckInput | null

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

Deck for the joining seat. Optional — a seat may join without a deck and submit one later through POST /api/matches/{match_id}/deck; the seat cannot mark itself ready until a deck has been submitted.

---

deckId?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { deckId } = joinMatchRequest

console.log(deckId)

optional deckId?: string | null

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

Freeform client deck id for the submitted deck.

---

deckTitle?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { deckTitle } = joinMatchRequest

console.log(deckTitle)

optional deckTitle?: string | null

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

Display title for the submitted deck.

---

formatSetup?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { formatSetup } = joinMatchRequest

console.log(formatSetup)

optional formatSetup?: FormatSetupInput | null

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

Optional setup data for formats that register more than one deck or a pool.

---

historyIdentities

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { historyIdentities } = joinMatchRequest

console.log(historyIdentities)

historyIdentities: HistoryIdentityInput[]

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

Personal identities that should own this joined seat's history entry.

---

name?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { name } = joinMatchRequest

console.log(name)

optional name?: string | null

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

Optional human-friendly display name for this joining seat. Same purpose as CreateMatchRequest::host_name — populates SeatState.name so other viewers can render the player's name instead of the seat enum.

---

profileUrl?

Example:

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

// Seat two submits a separate legal deck when joining the match.
const premierGuestDeck = {
  leader: 46107, // Darth Vader - Unstoppable
  leaders: [],
  base: 309, // Tarkintown
  cards: Array.from({ length: 50 }, () => 35), // TIE/ln Fighter
  sideboard: [],
}

const joinMatchRequest: JoinMatchRequest = {
  deck: premierGuestDeck,
  name: 'Guest',
  authenticated: false,
  historyIdentities: [],
}

const { profileUrl } = joinMatchRequest

console.log(profileUrl)

optional profileUrl?: string | null

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

Optional public profile page URL for this joining seat.