awesome-cordova-plugins/src/plugins/device.ts

57 lines
1.3 KiB
TypeScript
Raw Normal View History

import {Plugin, CordovaProperty} from './plugin';
2015-11-30 07:20:11 +08:00
2016-02-17 07:41:45 +08:00
declare var window: {
device: Device
};
2015-11-30 07:20:11 +08:00
2016-02-17 07:41:45 +08:00
export interface Device {
/** Get the version of Cordova running on the device. */
cordova: string;
/**
* The device.model returns the name of the device's model or product. The value is set
* by the device manufacturer and may be different across versions of the same product.
*/
model: string;
/** Get the device's operating system name. */
platform: string;
/** Get the device's Universally Unique Identifier (UUID). */
uuid: string;
/** Get the operating system version. */
version: string;
/** Get the device's manufacturer. */
manufacturer: string;
/** Whether the device is running on a simulator. */
isVirtual: boolean;
/** Get the device hardware serial number. */
serial: string;
}
/**
* @name Device
* @description
* Access information about the underlying device and platform.
*
* @usage
* ```js
* let info = Device.getDevice();
* ```
*/
2015-11-30 07:20:11 +08:00
@Plugin({
name: 'Device',
plugin: 'cordova-plugin-device',
pluginRef: 'device',
repo: 'https://github.com/apache/cordova-plugin-device'
2015-11-30 07:20:11 +08:00
})
export class Device {
/**
* Returns the whole device object.
2016-02-17 07:41:45 +08:00
*
* @returns {Object} The device object.
*/
@CordovaProperty
static get device() {
2015-11-30 07:20:11 +08:00
return window.device;
}
}