Files
awesome-cordova-plugins/src/@ionic-native/plugins/uptime/index.ts
T
2020-05-16 14:40:49 +02:00

42 lines
1.0 KiB
TypeScript

import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/**
* @name Uptime
* @description
* This plugin provides the time spent in milliseconds since boot (uptime).
*
* @usage
* ```typescript
* import { Uptime } from '@ionic-native/uptime/ngx';
*
* constructor(private uptime: Uptime) { }
*
* ...
*
* this.uptime.getUptime(includeDeepSleep)
* .then(uptime => console.log(uptime))
* .catch(error => console.log(error));
*
* ```
*/
@Plugin({
pluginName: 'Uptime',
plugin: 'cordova-plugin-uptime',
pluginRef: 'Uptime',
repo: 'https://github.com/s1lviu/cordova-plugin-uptime',
platforms: ['Android', 'iOS'],
})
@Injectable()
export class Uptime extends IonicNativePlugin {
/**
* This function return system uptime
* @param {boolean} includeDeepSleep Set to true to include system deep sleep
* @return {Promise<string>} Returns a promise that return the uptime in milliseconds
*/
@Cordova()
getUptime(includeDeepSleep: boolean): Promise<string> {
return;
}
}