mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-13 19:29:37 +08:00
94 lines
2.2 KiB
TypeScript
94 lines
2.2 KiB
TypeScript
import {Plugin, Cordova} from './plugin';
|
|
import {Observable} from 'rxjs/Observable';
|
|
|
|
export interface AccelerationData {
|
|
|
|
/**
|
|
* Amount of acceleration on the x-axis. (in m/s^2)
|
|
*/
|
|
x: number;
|
|
|
|
/**
|
|
* Amount of acceleration on the y-axis. (in m/s^2)
|
|
*/
|
|
y: number;
|
|
|
|
/**
|
|
* Amount of acceleration on the z-axis. (in m/s^2)
|
|
*/
|
|
z: number;
|
|
|
|
/**
|
|
* Creation timestamp in milliseconds.
|
|
*/
|
|
timestamp: any;
|
|
|
|
}
|
|
|
|
export interface AccelerometerOptions {
|
|
|
|
/**
|
|
* Requested period of calls to accelerometerSuccess with acceleration data in Milliseconds. Default: 10000
|
|
*/
|
|
frequency?: number;
|
|
|
|
}
|
|
|
|
/**
|
|
* @name Device Motion
|
|
* @description
|
|
* Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion docs](https://github.com/apache/cordova-plugin-device-motion).
|
|
*
|
|
* @usage
|
|
* ```ts
|
|
* import {DeviceMotion} from 'ionic-native';
|
|
*
|
|
*
|
|
*
|
|
* // Get the device current acceleration
|
|
* DeviceMotion.getCurrentAcceleration().then(
|
|
* acceleration => console.log(acceleration),
|
|
* error => console.log(error)
|
|
* );
|
|
*
|
|
* // Watch device acceleration
|
|
* var subscription = DeviceMotion.watchAcceleration().subscribe(acceleration => {
|
|
* console.log(acceleration);
|
|
* });
|
|
*
|
|
* // Stop watch
|
|
* subscription.unsubscribe();
|
|
*
|
|
* ```
|
|
*/
|
|
@Plugin({
|
|
plugin: 'cordova-plugin-device-motion',
|
|
pluginRef: 'navigator.accelerometer',
|
|
repo: 'https://github.com/apache/cordova-plugin-device-motion'
|
|
})
|
|
export class DeviceMotion {
|
|
|
|
/**
|
|
* Get the current acceleration along the x, y, and z axes.
|
|
* @returns {Promise<any>} Returns object with x, y, z, and timestamp properties
|
|
*/
|
|
@Cordova()
|
|
static getCurrentAcceleration(): Promise<AccelerationData> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Watch the device acceleration. Clear the watch by unsubscribing from the observable.
|
|
* @param {AccelerometerOptions} options list of options for the accelerometer.
|
|
* @returns {Observable<AccelerationData>} Observable returns an observable that you can subscribe to
|
|
*/
|
|
@Cordova({
|
|
callbackOrder: 'reverse',
|
|
observable: true,
|
|
clearFunction: 'clearWatch'
|
|
})
|
|
static watchAcceleration(options?: AccelerometerOptions): Observable<AccelerationData> {
|
|
return;
|
|
}
|
|
}
|