diff --git a/src/plugins/deviceorientation.ts b/src/plugins/deviceorientation.ts new file mode 100644 index 000000000..b5b8c3f5c --- /dev/null +++ b/src/plugins/deviceorientation.ts @@ -0,0 +1,99 @@ +import {Plugin, Cordova} from './plugin'; + +export interface CompassHeading { + + /** + * The heading in degrees from 0-359.99 at a single moment in time. (Number) + */ + magneticHeading : number, + + /** + * The heading relative to the geographic North Pole in degrees 0-359.99 at a single moment in time. A negative value indicates that the true heading can't be determined. (Number) + */ + trueHeading : number, + + /** + * The deviation in degrees between the reported heading and the true heading. (Number) + */ + headingAccuracy : number, + + /** + * The time at which this heading was determined. (DOMTimeStamp) + */ + timestamp : any + +} + +export interface CompassOptions { + + /** + * How often to retrieve the compass heading in milliseconds. (Number) (Default: 100) + */ + frequency : number, + + /** + * The change in degrees required to initiate a watchHeading success callback. When this value is set, frequency is ignored. (Number) + */ + filter : number + +} + +/** + * Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device Orientation docs](https://github.com/apache/cordova-plugin-device-orientation). + * + * ``` + * cordova plugin add https://github.com/apache/cordova-plugin-device-orientation.git + * ```` + * + * @usage + * ```js + * ``` + */ +@Plugin({ + plugin: 'https://github.com/apache/cordova-plugin-device-orientation', + pluginRef: 'navigator.compass' +}) +export class DeviceOrientation { + + /** + * Get the current compass heading. + * @returns {Promise} + */ + @Cordova() + static getCurrentHeading() : Promise { + // This Promise is replaced by one from the @Cordova decorator that wraps + // the plugin's callbacks. We provide a dummy one here so TypeScript + // knows that the correct return type is Promise, because there's no way + // for it to know the return type from a decorator. + // See https://github.com/Microsoft/TypeScript/issues/4881 + return new Promise((res, rej) => {}); + } + + /** + * Gets the device's current heading at a regular interval + * @param options + * @returns {Promise} + */ + @Cordova({ + successIndex: 0, + errorIndex: 1 + }) + static watchHeading(options? : CompassOptions) : Promise { + // This Promise is replaced by one from the @Cordova decorator that wraps + // the plugin's callbacks. We provide a dummy one here so TypeScript + // knows that the correct return type is Promise, because there's no way + // for it to know the return type from a decorator. + // See https://github.com/Microsoft/TypeScript/issues/4881 + return new Promise((res, rej) => {}); + } + + /** + * Stop watching the compass referenced by the watch ID parameter. + * @param watchID + */ + @Cordova({ + sync: true + }) + static clearWatch(watchID) : void {} + +}