@my-swu/simulator-client

---

@my-swu/simulator-client / RankedAdminStatus

Interface: RankedAdminStatus

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

Operator-facing ranked queue gauges included in simulator admin status.

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

console.log(rankedAdminStatus)

Properties

adminAdmissionEnabled

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { adminAdmissionEnabled } = rankedAdminStatus

console.log(adminAdmissionEnabled)

adminAdmissionEnabled: boolean

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

Whether an administrator has requested that new ranked queue entries remain open.

This records the mutable switch even when immutable deployment configuration currently prevents ranked use. The effective queue gate below also accounts for deployment state.

---

admissionEnabled

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { admissionEnabled } = rankedAdminStatus

console.log(admissionEnabled)

admissionEnabled: boolean

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

Whether new ranked queue entries are currently permitted.

This is false when either the immutable deployment capability is unavailable or an administrator has paused ranked admission. Ranked reads remain available while paused.

---

enabled

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { enabled } = rankedAdminStatus

console.log(enabled)

enabled: boolean

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

Whether deployment configuration supplies the ranked feature and identity secret.

---

openWindowSlug?

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { openWindowSlug } = rankedAdminStatus

console.log(openWindowSlug)

optional openWindowSlug?: string | null

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

---

pendingMatches

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { pendingMatches } = rankedAdminStatus

console.log(pendingMatches)

pendingMatches: number

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

---

searchingCount

Example:

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

const rankedAdminStatus: RankedAdminStatus = {
  "enabled": false,
  "adminAdmissionEnabled": false,
  "admissionEnabled": false,
  "searchingCount": 0,
  "pendingMatches": 0,
}

const { searchingCount } = rankedAdminStatus

console.log(searchingCount)

searchingCount: number

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