import { IonicNativePlugin } from '@ionic-native/core'; import { Observable } from 'rxjs'; /** * @name Screen Orientation * @premier screen-orientation * @description * Cordova plugin to set/lock the screen orientation in a common way. * * Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, please see the [Screen Orientation plugin docs](https://github.com/apache/cordova-plugin-screen-orientation). * * @usage * ```typescript * import { ScreenOrientation } from '@ionic-native/screen-orientation/ngx'; * * constructor(private screenOrientation: ScreenOrientation) { } * * ... * * * // get current * console.log(this.screenOrientation.type); // logs the current orientation, example: 'landscape' * * // set to landscape * this.screenOrientation.lock(this.screenOrientation.ORIENTATIONS.LANDSCAPE); * * // allow user rotate * this.screenOrientation.unlock(); * * // detect orientation changes * this.screenOrientation.onChange().subscribe( * () => { * console.log("Orientation Changed"); * } * ); * * ``` * * @advanced * * Accepted orientation values: * * | Value | Description | * |-------------------------------|------------------------------------------------------------------------------| * | portrait-primary | The orientation is in the primary portrait mode. | * | portrait-secondary | The orientation is in the secondary portrait mode. | * | landscape-primary | The orientation is in the primary landscape mode. | * | landscape-secondary | The orientation is in the secondary landscape mode. | * | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). | * | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). | * */ export declare class ScreenOrientationOriginal extends IonicNativePlugin { /** * Convenience enum for possible orientations */ ORIENTATIONS: { PORTRAIT_PRIMARY: string; PORTRAIT_SECONDARY: string; LANDSCAPE_PRIMARY: string; LANDSCAPE_SECONDARY: string; PORTRAIT: string; LANDSCAPE: string; ANY: string; }; /** * Listen to orientation change event * @return {Observable} */ onChange(): Observable; /** * Lock the orientation to the passed value. * See below for accepted values * @param orientation {string} The orientation which should be locked. Accepted values see table above. * @return {Promise} */ lock(orientation: string): Promise; /** * Unlock and allow all orientations. */ unlock(): void; /** * Get the current orientation of the device. */ type: string; } export declare const ScreenOrientation: ScreenOrientationOriginal;