System

This object allows you to get informations about the current operating system and execute some actions on it.

Constructor function.

var myObject = new System();

Returns the path of a standard storage location.

myObject.storageLocationPath(location);

1. location - (StorageLocation) the storage location

• (string) the storage location path

Returns the name of a standard storage location.

myObject.storageLocationName(location);

1. location - (StorageLocation) the storage location

• (string) the storage location name

Uses the default browser to open an URL.

myObject.openUrl(url);

1. url - (string) the URL to open

• (System) this System

• (OpenUrlError) cannot open the URL

Returns the screen count.

myObject.screenCount();

• (integer) the screen count

Returns the available geometry on a screen.

myObject.screenCount();

myObject.screenCount(screen);

1. screen - (integer) the screen (default: the default screen)

• (rect) the screen geometry

Returns the screen geometry.

myObject.screenGeometry();

myObject.screenGeometry(screen);

1. screen - (integer) the screen (default: the default screen)

• (rect) the screen geometry

Returns the primary screen index.

myObject.primaryScreen();

• (integer) the primary screen index

Returns true if the desktop is virtual. A virtual desktop may assemble multiple monitors into one screen.

myObject.isVirtualDesktop();

• (boolean) true if the desktop is virtual

Returns the color depth of a screen.

myObject.colorDepth(screen);

1. screen - (integer) the screen (default: the default screen)

• (integer) the color depth

Returns the display brightness of a screen.

myObject.displayBrightness(screen);

1. screen - (integer) the screen (default: the default screen)

• (integer) the display brightness

Returns the current directory.

myObject.currentDirectory();

• (string) the current directory

Returns the user name.

myObject.username();

• (string) the user name

Returns the value of an environment variable.

myObject.variable(name);

1. name - (string) the name of the environment variable

• (string) the value of the environment variable

Returns the current Unix timestamp.

myObject.timestamp();

• (integer) the current Unix timestamp

Returns the operating system name.

myObject.osName();

• (string) the operating system name

This method should return "GNU/Linux" or "Windows".

Returns the operating system version.

myObject.version();

• (string) the operating system version

Returns the current country code.

myObject.countryCode();

• (string) the current country code

Returns the current language.

myObject.language();

• (string) the current language

Returns an array of string representing the logical drives.

myObject.logicalDrives();

• (array) an array of string representing the logical drives

Returns the available disk space on a drive in bytes.

myObject.availableDiskSpace(drive);

1. drive - (string) the drive

• (integer) the available disk space on a drive in bytes

Returns the total disk space on a drive in bytes.

myObject.totalDiskSpace(drive);

1. drive - (string) the drive

• (integer) the total disk space on a drive in bytes

Returns the type of a drive.

myObject.driveType(drive);

1. drive - (string) the drive

• (DriveType) the drive type

Returns the battery level.

myObject.batteryLevel();

• (integer) the battery level (percentage)

Returns the power state.

myObject.powerState();

• (PowerState) the power state

Returns the device's manufacturer name.

myObject.manufacturer();

• (string) the manufacturer name

Returns the device's model name.

myObject.model();

• (string) the model name

Returns the device's product name.

myObject.productName();

• (string) the product name

Logouts the current user.

myObject.logout();

myObject.logout(force);

1. force - (boolean) force the logout

• (System) this System

• (LogoutError) unable to logout

Restarts the computer.

myObject.restart();

myObject.restart(force);

1. force - (boolean) force the restart

• (System) this System

• (RestartError) unable to restart

Stops the computer.

myObject.shutdown();

myObject.shutdown(force);

1. force - (boolean) force the shutdown

• (System) this System

• (ShutdownError) unable to shutdown

Suspends the computer.

myObject.suspend();

myObject.suspend(force);

1. force - (boolean) force the suspend

• (System) this System

• (SuspendError) unable to suspend

Hibernates the computer.

myObject.hibernate();

myObject.hibernate(force);

1. force - (boolean) force the hibernation

• (System) this System

• (HibernateError) unable to hibernate

Locks the screen.

myObject.lockScreen();

• (System) this System

• (LockScreenError) unable to lock the screen

Starts the screen saver.

myObject.startScreenSaver();

• (System) this System

• (StartScreenSaverError) unable to start the screen saver

A drive type.

1. UnknownDrive: an unknown drive
2. InternalDrive: an internal drive
3. RemovableDrive: a removable drive
4. RemoteDrive: a remote drive
5. CdromDrive: a cdrom drive

A power state.

1. UnknownState: unknown state
2. BatteryPower: on battery power
3. WallPower: on wall power
4. WallPowerChargingBattery: on wall power, charging the battery

A standard storage location.

1. Desktop: the desktop
2. Documents: the documents folder
3. Fonts: the fonts folder
4. Applications: the applications folder
5. Music: the music folder
6. Movies: the movies folder
7. Pictures: the pictures folder
8. Temp: the temporary files folder
9. Home: the home folder
10. Data: the data folder
11. Cache: the cache folder