Class KodiSystemNamespace

Index

Constructors

Methods

EjectOpticalDrive GetProperties Hibernate Reboot ShutDown Suspend

Constructors

constructor

new KodiSystemNamespace(sendMessage: ISendMessage): KodiSystemNamespace
Parameters
- sendMessage: ISendMessage
Returns KodiSystemNamespace
- Defined in namespaces/system.ts:15

Methods

EjectOpticalDrive

EjectOpticalDrive(): Promise<string>
Ejects or closes the optical disc drive (if available).

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/system.ts:24

GetProperties

GetProperties(properties: SystemPropertyName[]): Promise<SystemPropertyValue>
Retrieves the values of the given system properties.
Parameters
- properties: SystemPropertyName[]
  An array of system property names to retrieve.
Returns Promise<SystemPropertyValue>
A promise resolving to an object containing the requested system properties and their values.
- Defined in namespaces/system.ts:34

Hibernate

Hibernate(): Promise<string>
Puts the system running Kodi into hibernate mode.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/system.ts:47

Reboot

Reboot(): Promise<string>
Reboots the system running Kodi.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/system.ts:56

ShutDown

ShutDown(): Promise<string>
Shuts the system running Kodi down.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/system.ts:65

Suspend

Suspend(): Promise<string>
Suspends the system running Kodi.

Returns Promise<string>
A promise resolving to a string, typically empty on success.
- Defined in namespaces/system.ts:74