Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / JoinLobbyRequest

Interface: JoinLobbyRequest ​

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

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

console.log(joinLobbyRequest)

Properties ​

authenticated ​

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

const { authenticated } = joinLobbyRequest

console.log(authenticated)

authenticated: boolean

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

Whether the joining player is authenticated in the app.


avatarUrl? ​

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

const { avatarUrl } = joinLobbyRequest

console.log(avatarUrl)

optional avatarUrl?: string | null

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

Optional public avatar image URL for the joining player.


historyIdentities ​

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

const { historyIdentities } = joinLobbyRequest

console.log(historyIdentities)

historyIdentities: HistoryIdentityInput[]

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

Personal identities that should own this player's history.


name ​

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

const { name } = joinLobbyRequest

console.log(name)

name: string

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


profileUrl? ​

Example:

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

const joinLobbyRequest: JoinLobbyRequest = {
  "name": 'example',
  "authenticated": false,
  "historyIdentities": [],
}

const { profileUrl } = joinLobbyRequest

console.log(profileUrl)

optional profileUrl?: string | null

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

Optional public profile page URL for the joining player.

Released under the MIT License.