Gérer les plug-ins pour les applications générées à l'aide de Visual Studio Tools for Apache Cordova
Cet article fait référence à Visual Studio Tools pour Apache Cordova, qui correspond à la version préliminaire du logiciel. Les fonctionnalités décrites sont dans l'aperçu et sont sujettes à modification. Vous pouvez télécharger l'aperçu à partir du Centre de téléchargement Microsoft.
Apache Cordova utilise des plug-ins pour fournir l'accès aux fonctionnalités natives des appareils qui ne sont pas disponibles pour des applications web simples, comme l'accès au système de fichiers. Un plug-in est une bibliothèque Cordova interplateforme qui accède à des fonctionnalités natives du code et des appareils via une interface JavaScript. Quand c'est nécessaire, le plug-in met également à jour le manifeste de la plateforme pour activer les fonctionnalités de l'appareil. Certains plug-ins ne sont pas pris en charge ou ne sont pas nécessaires sur toutes les plateformes d'appareils.
Vous activez les plug-ins à l'aide du fichier config.xml de Cordova. Visual Studio fournit des méthodes pour mettre à jour ce fichier à l'aide du concepteur de configuration. Pour gérer les plug-ins dans votre application Cordova :
Utilisez le concepteur de configuration Visual Studio pour ajouter un plug-in à partir de l'ensemble principal de plug-ins Cordova ou pour ajouter un plug-in personnalisé.
Utilisez le concepteur de configuration pour mettre à jour un plug-in.
Modifiez le fichier config.xml pour spécifier les paramètres de plug-in.
Étendez ou créez un plug-in personnalisé.
Notes
Pour afficher les principaux plug-ins disponibles dans le concepteur de configuration, consultez la liste des plug-ins disponibles.Pour plus d'informations sur les plug-ins, consultez la documentation du fichier config.xml de Cordova.
Ajout d'un plug-in
Vous pouvez ajouter un plug-in Cordova principal, ou un plug-in personnalisé, à l'aide de Visual Studio. Vous pouvez également référencer des plug-ins supplémentaires à partir du Registre Cordova en modifiant le fichier config.xml. Quand vous générez votre solution, le plug-in est installé à partir du Registre Cordova.
Pour ajouter un plug-in dans le concepteur de configuration de Visual Studio
Dans l'Explorateur de solutions, ouvrez le menu contextuel du fichier config.xml, puis sélectionnez Ouvrir ou Concepteur de vues.
Dans le concepteur de configuration, sélectionnez l'onglet Plug-ins.
Sélectionnez le type de plug-in que vous voulez activer dans votre application (Principal ou Personnalisé). (Consultez la liste des plug-ins disponibles.)
Pour ajouter un plug-in principal, sélectionnez le plug-in et choisissez Ajouter.
Pour ajouter un plug-in personnalisé, spécifiez Local ou Git comme source, puis fournissez l'emplacement en parcourant ou en spécifiant un référentiel Git, comme indiqué.
Par exemple, le référentiel pour PushPlugin est : https://github.com/phonegap-build/PushPlugin.git
L'illustration ci-dessous montre la sélection d'un plug-in principal dans le concepteur de configuration.
L'illustration suivante montre comment ajouter un plug-in personnalisé à partir d'un référentiel Git dans le concepteur de configuration.
Quand vous ajoutez le plug-in, Visual Studio apporte également des modifications à votre fichier config.xml.
Pour plus d'informations sur l'édition du fichier config.xml, consultez la documentation du fichier config.xml de Cordova.
Quand vous ajoutez un plug-in personnalisé, Visual Studio ajoute également la structure de fichiers et de dossiers du plug-in au projet, dans le dossier plugins. Les fichiers importants du plug-in incluent : plugin.xml, le dossier src du plug-in et le dossier www du plug-in.
Pour supprimer un plug-in, recherchez-le dans le concepteur de configuration et choisissez Supprimer.
Pour écrire du code pour un plug-in particulier, consultez les Informations de référence sur l'API Cordova.
Mise à jour d'un plug-in
Utilisez le concepteur de configuration pour mettre à jour un plug-in vers une version plus récente. Vous pouvez mettre à jour un plug-in en utilisant l'emplacement source Git ou, si vous avez téléchargé un plug-in, en accédant à son dossier local dans le concepteur de configuration.
Le Registre de plug-ins Cordova fournit des informations sur les différentes versions des plug-ins.
Configuration des paramètres de plug-in
Après avoir ajouté un plug-in à l'aide du concepteur de configuration, vous pouvez configurer ses paramètres en modifiant le fichier config.xml (sélectionnez Afficher le code dans le menu contextuel de config.xml).
Par exemple, pour configurer le plug-in Facebook, modifiez les paramètres ci-dessous dans 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>
Cela équivaut à exécuter la commande suivante sur la ligne de commande (si vous n'utilisiez pas Visual Studio) :
cordova plugin add https://github/com/Wizcorp/phonegap-facebook-plugin.git --variable APP_ID="12345678" –variable APP_NAME="My Facebook App"
Extension d'un plug-in personnalisé
Parfois, les plug-ins personnalisés du Registre Cordova peuvent ne pas satisfaire à toutes les spécifications requises de votre application. Il peut donc être nécessaire d'étendre un plug-in ou de créer votre propre plug-in. Par exemple, si vous devez décharger des fonctions gourmandes en ressources vers du code natif, exposer de nouvelles fonctionnalités à votre application ou appliquer un correctif à un plug-in existant que vous préféreriez ne pas distribuer publiquement, vous pouvez étendre ou créer un plug-in. Vous pouvez trouver plus d'informations sur la création de vos propres plug-ins dans le guide de développement des plug-ins dans la documentation de Cordova.
Si vous avez besoin d'étendre votre application à l'aide d'un plug-in personnalisé, commencez par examiner le registre de plug-ins et utilisez du code que d'autres ont déjà écrit. Si un plug-in existant se rapproche de ce que vous recherchez, téléchargez-le, apportez des améliorations, puis soumettez ces modifications à l'auteur d'origine. Ceci est un excellent moyen d'apporter une contribution à la communauté Cordova et d'aider les autres à résoudre des problèmes similaires.
Installez le plug-in personnalisé à l'aide du concepteur de configuration. Quand le fichier plugin.xml est adjacent au dossier www dans l'arborescence des dossiers du projet, les fichiers JavaScript requis issus du dossier www du plug-in seront chargés automatiquement au moment de l'exécution. Vous n'avez pas besoin de faire référence à ces fichiers dans un fichier HTML. Vous pouvez également définir des points d'arrêt dans ces fichiers de code, si nécessaire. Le processus de génération compile également tous les fichiers spécifiques à la plateforme dans le dossier src.
Liste des plug-ins disponibles dans le concepteur de configuration
Les plug-ins suivants sont disponibles lors de l'utilisation du concepteur de configuration :
Accelerometer / Device Motion (org.apache.cordova.device-motion)
Fournit l'accès à un capteur de mouvement qui détecte des modifications dans les déplacements quant à l'orientation de l'appareil.
Azure Mobile Services Client (com.msopentech.azure-mobile-services)
Ajoute la bibliothèque du client Azure Mobile Services appropriée à votre application pour chaque plateforme et permet à votre application de synchroniser du contenu avec une instance Azure Mobile Services.
Battery Status (Android, iOS, Windows Phone 8) (org.apache.cordova.battery-status)
Permet à votre application de gérer un événement qui est déclenché quand la charge disponible dans la batterie augmente ou diminue d'au moins 1 %, ou quand l'appareil est connecté ou déconnecté d'une prise de courant.
Camera (org.apache.cordova.camera)
Permet à votre application de prendre des photos à l'aide de l'application de caméra par défaut de l'appareil.
Compass (org.apache.cordova.device-orientation)
Fournit l'accès à un capteur qui détecte l'orientation ou la tête de l'appareil en fonction de la direction dans laquelle l'appareil est placé.
Connection (org.apache.cordova.network-information)
Permet à votre application de déterminer l'état de la connexion réseau de l'appareil et les types de réseaux auxquels il est connecté.
Console (org.apache.cordova.console)
Fournit une implémentation différente de console.log (pour une utilisation comme solution de contournement des problèmes de console.log).
Contacts (org.apache.cordova.contacts)
Fournit l'accès à la base de données Contacts de l'appareil. Votre application peut rechercher, ajouter ou supprimer des contacts.
Device (org.apache.cordova.device)
Fournit l'accès aux informations sur le matériel et les logiciels de l'appareil. Par exemple, il peut s'agir du numéro de modèle ou de la plateforme de l'appareil.
Dialogs / Notifications (org.apache.cordova.dialogs)
Permet à votre application d'afficher des boîtes de dialogue.
File System (org.apache.cordova.file)
Permet à votre application de lire, d'écrire et de naviguer dans le système de fichiers de l'appareil.
File Transfer (org.apache.cordova.file-transfer)
Permet à votre application de télécharger des fichiers vers et depuis un serveur.
Geolocation (org.apache.cordova.geolocation)
Fournit des informations sur l'emplacement de l'appareil, comme la latitude et la longitude.
Globalization (org.apache.cordova.globalization)
Permet à votre application d'obtenir des informations sur les paramètres régionaux et le fuseau horaire de l'utilisateur, puis d'effectuer des opérations qui sont spécifiques à ces paramètres régionaux et à ce fuseau horaire.
InAppBrowser (org.apache.cordova.inappbrowser)
Permet à votre application d'héberger un navigateur web, puis d'effectuer des actions en réponse à des événements liés au navigateur, comme l'insertion de feuilles de style CSS dans la fenêtre du navigateur quand une page est chargée.
Notes
Actuellement, l'association du débogueur à des applications iOS utilisant le plug-in InAppBrowser n'est pas prise en charge.Le plug-in Azure Mobile Services utilise le plug-in InAppBrowser et est affecté par cette limitation.
Media (org.apache.cordova.media)
Permet à votre application de lire et d'enregistrer des fichiers audio en utilisant l'application par défaut de l'appareil.
Media Capture (org.apache.cordova.media-capture)
Fournit l'accès aux fonctionnalités de capture audio, image et vidéo de l'appareil.
Splashscreen (org.apache.cordova.splashscreen)
Permet à votre application d'afficher et de masquer son écran de démarrage.
Vibration (org.apache.cordova.vibration)
Permet à votre application de faire vibrer l'appareil.
WebSQL Polyfill (Windows, Windows Phone 8) (com.msopentech.websql)
Active WebSQL sur toutes les plateformes en ajoutant la fonctionnalité WebSQL à votre application sur Windows et Windows Phone 8.
Voir aussi
Concepts
Installer Visual Studio Tools for Apache Cordova