共用方式為


管理由 Visual Studio Tools for Apache Cordova 建置之應用程式的外掛程式

本主題適用於發行前版本軟體 -- Apache Cordova 的 Visual Studio Tools。這些功能描述於預覽中,但有可能變更。您可以從 Microsoft 下載中心下載此 Preview。

Apache Cordova 使用「外掛程式」(Plugin) 來提供簡單 Web 應用程式不提供之原生裝置功能的存取,例如檔案系統的存取。 外掛程式是跨平台 Cordova 程式庫,可透過 JavaScript 介面存取機器碼和裝置功能。 必要時,外掛程式也會更新平台資訊清單,以啟用裝置功能。 並非所有裝置平台都支援或需要所有外掛程式。

您可以使用 Cordova config.xml 檔啟用外掛程式。 Visual Studio 提供方法,透過組態設計工具來更新這個檔案。 在 Cordova 應用程式中管理外掛程式:

  • 使用 Visual Studio 組態設計工具,從一組核心 Cordova 外掛程式加入外掛程式或加入自訂外掛程式。

  • 使用組態設計工具更新外掛程式。

  • 編輯 config.xml 以指定外掛程式參數。

  • 擴充或建立自訂外掛程式

注意事項注意事項

若要查看組態設計工具中可用的核心外掛程式,請參閱可用的外掛程式清單。如需外掛程式的詳細資訊,請參閱 Cordova config.xml 文件

加入外掛程式

您可以使用 Visual Studio 加入核心 Cordova 外掛程式或自訂外掛程式。 您也可以透過編輯 config.xml,參考 Cordova 登錄中的其他外掛程式。 當您建置方案時,會從 Cordova 登錄安裝外掛程式。

在 Visual Studio 組態設計工具中加入外掛程式

  1. 在 [方案總管] 中,開啟 config.xml 檔的捷徑功能表,然後選擇 [開啟] 或 [設計工具檢視]。

  2. 在組態設計工具中,選擇 [外掛程式] 索引標籤。

  3. 選取您要在應用程式中啟用的外掛程式類型 ([核心] 或 [自訂])。 (請參閱可用的外掛程式清單。)

    • 若要加入核心外掛程式,請在選取外掛程式後選擇 [加入]。

    • 若要加入自訂外掛程式,請指定 [本機] 或 [Git] 作為來源,然後再如下所示瀏覽或指定 Git 儲存機制以提供位置。

      例如,https://github.com/phonegap-build/PushPlugin.git 為 PushPlugin 的儲存機制

    下圖顯示組態設計工具中選取的核心外掛程式。

    加入外掛程式

    下圖顯示如何從 Git 儲存機制將自訂外掛程式加入組態設計工具。

    加入自訂外掛程式

  4. 加入外掛程式時,Visual Studio 也會變更 config.xml 檔。

    如需編輯 config.xml 的詳細資訊,請參閱 Cordova config.xml 文件

    加入自訂外掛程式時,Visual Studio 也會將外掛程式資料夾和檔案結構加入 [外掛程式] 資料夾中的專案。 重要的外掛程式檔包括:plugin.xml、外掛程式的 src 資料夾以及外掛程式的 www 資料夾。

若要移除外掛程式,請尋找組態設計工具中的外掛程式並選擇 [移除]。

若要撰寫特定外掛程式的程式碼,請參閱 Cordova API 參考

更新外掛程式

使用組態設計工具將外掛程式更新為較新版本。 您可使用 Git 來源位置更新任何外掛程式,或者,如果您已下載外掛程式,則可從組態設計工具瀏覽至它的本機資料夾。

Cordova 外掛程式登錄提供不同外掛程式版本的相關資訊。

設定外掛程式參數

使用組態設計工具加入外掛程式後,您可編輯 config.xml 檔以設定參數 (從 config.xml 的捷徑功能表選取 [檢視程式碼])。

例如,若要設定 Facebook 外掛程式,您可編輯 config.xml 中的下列參數。

<vs:plugin name="com.phonegap.plugins.facebookconnect" version="0.8.1">
    <param name="APP_ID" value="12345678" />
    <param name="APP_NAME" value="My Facebook App" />
</vs:plugin>

這和從命令列執行下列命令產生的結果相同 (如果您不是使用 Visual Studio 的話):

cordova plugin add https://github/com/Wizcorp/phonegap-facebook-plugin.git --variable APP_ID="12345678" –variable APP_NAME="My Facebook App"

擴充自訂外掛程式

有時候,Cordova 登錄中的自訂外掛程式可能無法滿足您所有的應用程式需求,因此您需要擴充外掛程式或建立自己的外掛程式。 例如,如果您需要將高度耗費計算能力的函式卸載至機器碼、將新的裝置功能公開給您的應用程式,或將修正程式套用至您不想公開發行的現有外掛程式,您可能需要擴充或建立自己的外掛程式。 如需建立您自己的外掛程式之詳細資訊,請參閱 Cordova 文件中的外掛程式開發指南

如果您要使用自訂外掛程式來擴充應用程式,請先檢查外掛程式登錄並使用其他人已撰寫的程式碼。 如果現有外掛程式很接近您的需求,您可將其下載改進後,再將這些變更提交給原作者。 這是回饋 Cordova 社群的絕佳方式,亦有助其他人能更輕鬆解決類似的問題。

使用組態設計工具安裝自訂外掛程式。 如果 plugin.xml 檔位於專案資料夾樹狀目錄中 www 資料夾旁邊,外掛程式 www 資料夾所需的 JavaScript 檔就會在執行階段自動載入。 您不需要從 HTML 檔案來參考這些檔案。 您也可以視需要在這些程式碼檔案內設定中斷點。 建置流程也會編譯 src 資料夾中的任何平台專屬檔案。

組態設計工具中可用的外掛程式清單

以下是使用組態設計工具提供的外掛程式:

  • 加速計/裝置移動 (org.apache.cordova.device-motion)

    提供動作感應器的存取,該感應器可偵測相對於設備方向之移動的變更。

  • Azure 行動服務用戶端 (com.msopentech.azure-mobile-services)

    將適當的 Azure 行動服務用戶端程式庫加入至每個平台的應用程式,並將應用程式的內容與 Azure 行動服務執行個體同步處理。

  • 電池狀態 (Android、iOS、Windows Phone 8) (org.apache.cordova.battery-status)

    可讓您的應用程式處理電池的可用電量增加或減少至少 1% 時,或裝置接上電源插座或從電源插座拔下時,所引發的事件。

  • 相機 (org.apache.cordova.camera)

    可讓您的應用程式使用裝置的預設相機應用程式來拍照。

  • 指南針 (org.apache.cordova.device-orientation)

    提供感應器的存取,該感應器可依據裝置所指的方向來偵測裝置的方向或朝向。

  • 連線 (org.apache.cordova.network-information)

    可讓您的應用程式判斷裝置的網路連線狀態,以及裝置連線的網路類型。

  • 主控台 (org.apache.cordova.console)

    提供 console.log 的不同實作 (用來做為解決 console.log 問題的因應措施)。

  • 連絡人 (org.apache.cordova.contacts)

    提供裝置之連絡人資料庫的存取。 您的應用程式可以尋找、加入或移除連絡人。

  • 裝置 (org.apache.cordova.device)

    提供裝置之軟硬體相關資訊的存取。 例如,這項資訊可能是裝置的型號或平台。

  • 對話方塊/通知 (org.apache.cordova.dialogs)

    可讓您的應用程式顯示對話方塊。

  • 檔案系統 (org.apache.cordova.file)

    可讓您的應用程式讀取、寫入及瀏覽裝置的檔案系統。

  • 檔案傳輸 (org.apache.cordova.file-transfer)

    可讓您的應用程式將檔案上傳至伺服器,或從伺服器下載檔案。

  • 地理位置 (org.apache.cordova.geolocation)

    提供裝置位置的相關資訊,例如經度和緯度。

  • 全球化 (org.apache.cordova.globalization)

    可讓您的應用程式取得使用者地區設定和時區的相關資訊,然後執行該地區設定和時區專屬的作業。

  • InAppBrowser (org.apache.cordova.inappbrowser)

    可讓您的應用程式裝載 Web 瀏覽器,然後執行動作以回應與瀏覽器相關的事件,例如在網頁載入時,將 CSS 插入瀏覽器視窗中。

    注意事項注意事項

    目前不支援將偵錯工具附加至使用 InAppBrowser 外掛程式的 iOS 應用程式。Azure 行動服務外掛程式使用 InAppBrowser 外掛程式,因此也會受到這項限制的影響。

  • 媒體 (org.apache.cordova.media)

    可讓您的應用程式使用裝置的預設應用程式播放及錄製音訊檔案。

  • 媒體擷取 (org.apache.cordova.media-capture)

    提供裝置之音訊、影像和視訊擷取功能的存取。

  • 啟動顯示畫面 (org.apache.cordova.splashscreen)

    可讓您的應用程式顯示及隱藏其啟動顯示畫面。

  • 震動 (org.apache.cordova.vibration)

    可讓您的應用程式震動裝置。

  • WebSQL Polyfill (Windows、Windows Phone 8) (com.msopentech.websql)

    透過將 WebSQL 功能加入至 Windows 和 Windows Phone 8 上的應用程式,啟用所有平台上的 WebSQL。

請參閱

概念

安裝 Visual Studio Tools for Apache Cordova

其他資源

Cordova config.xml 文件

Cordova 外掛程式登錄

常見問題集