Cordova Screen Orientation 插件使用教程

1. 项目的目录结构及介绍

cordova-plugin-screen-orientation/
├── src/
│   ├── android/
│   ├── ios/
│   ├── windows/
│   └── ...
├── www/
│   └── screenorientation.js
├── package.json
├── plugin.xml
└── README.md

• src/: 包含各个平台的具体实现代码。
  • android/: Android 平台的实现代码。
  • ios/: iOS 平台的实现代码。
  • windows/: Windows 平台的实现代码。
• www/: 包含插件的公共 JavaScript 文件。
  • screenorientation.js: 插件的主要逻辑文件。
• package.json: 插件的 npm 配置文件。
• plugin.xml: 插件的配置文件，定义了插件的元数据和依赖关系。
• README.md: 插件的说明文档。

2. 项目的启动文件介绍

插件的主要启动文件是 www/screenorientation.js。这个文件定义了插件的核心功能，包括锁定和解锁屏幕方向的方法。

// www/screenorientation.js
var exec = require('cordova/exec');

var screenOrientation = {
    ORIENTATIONS: {
        PORTRAIT_PRIMARY: "portrait-primary",
        PORTRAIT_SECONDARY: "portrait-secondary",
        LANDSCAPE_PRIMARY: "landscape-primary",
        LANDSCAPE_SECONDARY: "landscape-secondary",
        PORTRAIT: "portrait",
        LANDSCAPE: "landscape",
        ANY: "any"
    },
    lock: function (orientation) {
        exec(null, null, "CDVOrientation", "lock", [orientation]);
    },
    unlock: function () {
        exec(null, null, "CDVOrientation", "unlock", []);
    },
    getOrientation: function (successCallback) {
        exec(successCallback, null, "CDVOrientation", "getOrientation", []);
    }
};

module.exports = screenOrientation;

3. 项目的配置文件介绍

插件的配置文件是 plugin.xml。这个文件定义了插件的元数据、平台依赖和文件映射。

<!-- plugin.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
        id="cordova-plugin-screen-orientation"
        version="3.0.2">
    <name>Screen Orientation</name>
    <description>Cordova Screen Orientation Plugin</description>
    <license>Apache 2.0</license>
    <keywords>cordova,orientation</keywords>
    <repo>https://github.com/apache/cordova-plugin-screen-orientation.git</repo>
    <issue>https://github.com/apache/cordova-plugin-screen-orientation/issues</issue>

    <js-module src="www/screenorientation.js" name="screenorientation">
        <clobbers target="screen.orientation" />
    </js-module>

    <platform name="android">
        <config-file target="res/xml/config.xml" parent="/*">
            <feature name="ScreenOrientation">
                <param name="android-package" value="org.apache.cordova.screenorientation.ScreenOrientation"/>
            </feature>
        </config-file>
        <source-file src="src/android/ScreenOrientation.java" target-dir="src/org/apache/cordova/screenorientation"/>
    </platform>

    <platform name="ios">
        <config-file target="config.xml" parent="/*">
            <feature name="ScreenOrientation">
                <param name="ios-package" value="CDVOrientation"/>
            </feature>
        </config-file>
        <header-file src="src/ios/CDVOrientation.h"/>
        <source-file src="src/ios/CDVOrientation.m"/>
    </platform>

    <platform name="windows">
        <config-file target="config.xml" parent="/*">
            <feature name="ScreenOrientation">
                <param name="windows-package" value="CDVOrientation"/>
            </feature>
        </