Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientIssues

A class responsible for tracking issues in the current world.

Hierarchy

  • ClientIssues

Index

Constructors

Methods

Accessors

Properties

Constructors

constructor

Methods

_detectWebGLIssues

  • _detectWebGLIssues(): void

  • Detect and display warnings for known performance issues which may occur due to the user's hardware or browser configuration.

    internal

    Returns void

_countDocumentSubType

  • _countDocumentSubType(documentName: string, source: any, options?: { decrement: boolean }): void

  • Add an invalid Document to the module-provided sub-type counts.

    internal

    Parameters

    • documentName: string

      The Document name.

    • source: any

      The Document's source data.

    • options: { decrement: boolean } = {}
      • decrement: boolean

    Returns void

_trackValidationFailure

  • _trackValidationFailure(collection: WorldCollection, source: any, error: DataModelValidationError): void

  • Track a validation failure that occurred in a WorldCollection.

    internal

    Parameters

    • collection: WorldCollection

      The parent collection.

    • source: any

      The Document's source data.

    • error: DataModelValidationError

      The validation error.

    Returns void

_detectUsabilityIssues

  • _detectUsabilityIssues(): void

  • Detect and record certain usability error messages which are likely to result in the user having a bad experience.

    internal

    Returns void

getSubTypeCountsFor

  • getSubTypeCountsFor(module: string | Module): any

  • Get the Document sub-type counts for a given module.

    Parameters

    • module: string | Module

      The module or its ID.

    Returns any

getAllSubTypeCounts

  • getAllSubTypeCounts(): Iterator<string, any, undefined>

  • Retrieve all sub-type counts in the world.

    Returns Iterator<string, any, undefined>

Private #countDocumentSubType

  • #countDocumentSubType(documentName: string, subType: string, [options]?: { decrement: boolean }): void

  • Add a Document to the count of module-provided sub-types.

    Parameters

    • documentName: string

      The Document name.

    • subType: string

      The Document's sub-type.

    • [options]: { decrement: boolean } = {}
      • decrement: boolean

    Returns void

Private #detectBrowserVersion

  • #detectBrowserVersion(): void

  • Detect the user's browser and display a notification if it is below the minimum required version.

    Returns void

Private #detectResolution

  • #detectResolution(): void

  • Detect the user's resolution and display a notification if it is too small.

    Returns void

Accessors

validationFailures

  • get validationFailures(): any

  • Retrieve the tracked validation failures.

    Returns any

usabilityIssues

  • get usabilityIssues(): any

  • Retrieve the tracked usability issues.

    Returns any

packageCompatibilityIssues

  • get packageCompatibilityIssues(): any

  • Retrieve package compatibility issues.

    Returns any

Properties

Private #moduleTypeMap

#moduleTypeMap: Map<string, any> = ...

Keep track of valid Documents in the world that are using module-provided sub-types.

Private #documentValidationFailures

#documentValidationFailures: any = {}

Keep track of document validation failures.

Private #usabilityIssues

#usabilityIssues: any = {}

Keep track of any usability issues related to browser or technology versions.

Private #resolutionTooLowNotification

#resolutionTooLowNotification: number

Record a reference to a resolution notification ID so that we can remove it if the problem is remedied.

Static Private #MIN_RESOLUTION

#MIN_RESOLUTION: { WIDTH: number; HEIGHT: number } = ...

The minimum supported resolution.

Type declaration

  • WIDTH: number
  • HEIGHT: number

Static Private #BROWSER_TESTS

#BROWSER_TESTS: any = ...

The minimum supported client versions.