Options
All
  • Public
  • Public/Protected
  • All
Menu

System API.

Hierarchy

  • SystemAPI

Index

Properties

BackupManager

BackupManager: BackupManagerAPI

API to manage system backups.

DevProfileManager

DevProfileManager: DevProfileManager

Device profile manager. Used to handle different device types (e.g. mobile, desktop, etc.).

DirMetadataReader

DirMetadataReader: DirMetadataReader

A class to read directory metadata.

EventLog

EventLog: { prototype: EventLogInstance }

Represents an event log, which logs information, errors, and warnings.

Type declaration

MobileDeviceConfiguration

MobileDeviceConfiguration: { applyPatches: any; getDeviceType: any; isMobileModeEnabled: any }

Mobile device configuration manager.

Type declaration

  • applyPatches: function
    • applyPatches(): Promise<void>
    • Apply mobile device patches.

      Returns Promise<void>

  • getDeviceType: function
    • getDeviceType(): string
    • Gets the mobile device type.

      Returns string

  • isMobileModeEnabled: function
    • isMobileModeEnabled(): boolean
    • Checks whether mobile mode is enabled.

      Returns boolean

OSRelease

OSRelease: OSRelease

An object representing the current Windows 96 OS release.

PkMgr

PkMgr: { prototype: PackMan }

An object representing the Windows 96 package manager.

Type declaration

Service

Service: { prototype: OSService }

A class representing an OS service.

This class should be inherited.

Type declaration

ServiceManager

ServiceManager: { prototype: ServiceManager }

Represents an OS service manager.

Type declaration

biosConfig

biosConfig: BiosConfigManager

BIOS (setup) configuration manager.

capi

capi: C_API

Windows 96 C API utilities.

env

An object representing the current system environment.

Environment variables and such may be defined here.

features

Host features manager. Use it to query if features are available (e.g. WebAssembly).

flags

Manages system flags.

kInfo

kInfo: KernelInfo

Contains current kernel information.

loader

loader: LoaderAPI

System loader API.

log

System event log.

reg

reg: RegNS

System registry namespace.

Its main purpose is to administer the registration of apps.

sam

sam: SAMAPI

SAM API.

services

services: ServiceManager

OS services.

swfsbr

swfsbr: { isOnline: any }

Service Worker FS bridge utils.

Type declaration

  • isOnline: function
    • isOnline(): boolean
    • Checks whether the service worker FS bridge is available.

      Returns boolean

wex

wex: WEXAPI

Windows 96 eXecutable API (for C/C++ native) apps.

Methods

execCmd

  • execCmd(cmd: string, argv?: string[], boxedEnv?: [], customPaths?: string[]): Promise<any>
  • Executes a command.

    Parameters

    • cmd: string

      The command to execute.

    • Optional argv: string[]

      The arguments to pass.

    • Optional boxedEnv: []

      Environment for the app.

    • Optional customPaths: string[]

      Custom path values for the call.

    Returns Promise<any>

    App result.

execFile

  • execFile(path: string, boxedEnv?: any): Promise<any>
  • Opens a file.

    Parameters

    • path: string

      The path of the file to open.

    • Optional boxedEnv: any

      Environment to pass to WRT box.

    Returns Promise<any>

    A result from whatever application executed the file.

reboot

  • reboot(noUI?: boolean): Promise<never>
  • Reboots the system.

    Parameters

    • Optional noUI: boolean

      Whether a closing UI should be shown.

    Returns Promise<never>

renderBSOD

  • renderBSOD(message: string): Promise<void>
  • Renders a BSOD (blue screen of death).

    Parameters

    • message: string

      The message to render.

    Returns Promise<void>

setKernImage

  • setKernImage(path: string): Promise<void>
  • Sets the kernel image.

    Parameters

    • path: string

      The path of the kernel image to use.

    Returns Promise<void>

shutdown

  • shutdown(): void
  • Shuts down the system.

    Returns void

Generated using TypeDoc