license: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
Desde la versión 3.0 adelante, Cordova implementa todas las APIs del dispositivo como plugins y les deja desactivado por defecto. También soporta dos formas diferentes para agregar y quitar plugins, dependiendo de su elección de flujo de trabajo discutida en la Descripción:
Si utiliza un flujo de trabajo multiplataforma, utiliza el cordova utilidad CLI para agregar plugins, tal como se describe en la interfaz de línea de comandos. La CLI modifica plugins para todas las plataformas especificadas a la vez.
Si utiliza un flujo de trabajo centrado en plataforma, utilice una interfaz de comandos de Plugman de nivel inferior, por separado para cada plataforma de destino.
Esta sección detalla la utilidad Plugman. Para más información sobre consumo de Plugman como un módulo de nodo o modificar el código fuente, vea el archivo Léame en su repositorio.
Para instalar Plugman, tu debes tener node instalado en tu computadora. A continuación, puede ejecutar el siguiente comando desde cualquier parte en su entorno para instalar plugman en todo el mundo, que está disponible desde cualquier directorio:
$ npm install -g plugman
Además debes tener git en tu PATH para poder instalar los plugins directamente desde URLs remotas de git.
TIP: Si encuentras que después de instalar el plugman con npm no es todavía capaz de ejecutar cualquiera plugman comandos, asegúrese de que ha agregado la /npm/ Directorio en tuPATH.
Nota: puede omitir este paso si no quieres contaminar su global npm espacio de nombres mediante la instalación de Plugman en todo el mundo. Si este es el caso, entonces cuando se crea un proyecto de Córdoba con las herramientas de shell, habrá un node_modules directorio dentro de su proyecto que contiene Plugman. Dado que no se instalar en todo el mundo, hace falta invocar node para cada comando Plugman, por ejemplo node ./node_modules/plugman/main.js -version . El resto de esta guía asume que ha instalado Plugman en todo el mundo, significa que usted puede invocar con sóloplugman.
Antes de que puedas utilizar Plugman, debes crear un proyecto Cordova. Puedes hacer esto del mismo modo utilizando la Interfaz de línea de comandos o bien con scripts shell de bajo nivel. Las instrucciones para utilizar los scripts del shell para crear tu proyecto se encuentran en las guías “Herramientas de línea de comandos” listadas en la página de las Guías de plataformas.
Una vez que has instalado Plugman y creado un proyecto Cordova, puedes comenzar a añadir plugins a la plataforma utilizando el siguiente comando:
$ plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project <directory> --plugin <name|url|path> [--plugins_dir <directory>] [--www <directory>] [--variable <name>=<value> [--variable <name>=<value> ...]]
Usando una mínima cantidad de parámetros, este comando instala un plugin en un proyecto Cordova. Debes especificar una plataforma y la ubicación de un proyecto Cordova para dicha plataforma. Además, debes especificar un plugin con las diferentes formas del parámetro --plugin , las mismas son:
name: El nombre del directorio en dnde reside el plugin. Este debe ser un directorio dentro del path --plugins_dir (ve más abajo por más información) o un plugin del Cordova registry.url: Una URL que comience https:// o git://, y apunte a un repositorio git válido que es clonable y contenga el archivo plugin.xml. Los contenidos de este repositorio serán copiados a --plugins_dir.path: Una ruta a un directorio que contenga un plugin válido el cual incluya el archivo plugin.xml. El contenido de esta ruta será copiada a --plugins_dir.Otro parámetros:
--plugins_dir cuyo valor por defecto es <project>/cordova/plugins, pero puede ser cualquier directorio que contenga un subdirectorio por cada plugin.--www cuyo valor por defecto es la ruta de la carpeta www, pero puede ser cualquier directorio del proyecto Cordova que es utilizado como para los assets de la aplicación web.--variable permite especificar ciertas variables en el momento de la instalación, necesario para aquellos plugins que requieras una key del API u otros parámetros personalizados por el usuario. Por favor, vea la Especificación plugin para obtener más información.Para desinstalar un plugin, simplemente pasa el flag --uninstall e indica el ID del plugin.
$ plugman --uninstall --platform <ios|amazon-fireos|android|blackberry10|wp8> --project <directory> --plugin <id> [--www <directory>] [--plugins_dir <directory>]
Plugman ofrece un comando de ayuda global el cual puede ayudarte si no sabes como continuar o si estás experimentando problemas. Esta ayuda mostrará la lista de todos los comandos disponibles de Plugman y su sintaxis:
plugman -help plugman # same as above
NOTA: plugman -help puede mostrar algún comando adicional del registry. Estos comandos son para desarrolladores de plugins y no deben ser implementados por registros de plugin de terceras partes.
Además puede añadir el flag --debug|-d a cualquier comando Plugman que corra en modo verboso, el cual mostrará cualquier mensaje interno de depuración del mismo modo en el que son emitidos de manera que pueda ayudarte a encontrar el origen de problemas, como por ejemplo, archivos inexistentes.
# Adding Android battery-status plugin to "myProject": plugman -d --platform android --project myProject --plugin cordova-plugin-battery-status
Finalmente, puedes utilizar el flag --version|-v para ver que versión de Plugman te encuentras utilizando.
plugman -v
Estos son comando que pueden ser utilizados para interactuar con el Plugin registry. Por favor, nota que que estos comandos son específicos del registro de plugins plugins.cordova.io y no deben ser implementados por registros de terceras partes.
Puedes utilizar Plugman para buscar el id de un plugin dentro del Plugin registry que se corresponda con la lista de palabras clave separadas por espacios.
plugman search <plugin keywords>
Puedes obtener o indicar la URL de los registros de plugins que actualmente plugman está usando. Generalmente tu debes utilizar este valor http://registry.cordova.io a menos que quieras utilizar un plugín en un registro de plugins de una tercera parte.
plugman config set registry <url-to-registry> plugman config get registry
Puedes obtener información acerca de cualquier plugin que se encuentre almacenado en el repositorio de plugins con el siguiente comando:
plugman info <id>
Esto contactará al registro de plugins y obtendrá información como la versión del plugin.
Los ejemplos siguientes muestran cómo agregar plugins según sea necesario para que cualquier APIs Cordova utilizas en tu proyecto todavía funcionan después de actualizar a la versión 3.0. Para cada comando, debes seleccionar la plataforma de destino y directorio del proyecto de la plataforma de referencia.
cordova-plugin-battery-status
plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-battery-status
cordova-plugin-camera plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-camera
cordova-plugin-console plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-console
cordova-plugin-contacts plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-contacts
cordova-plugin-device plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-device
cordova-plugin-device-motion (accelerometer) plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-device-motion
cordova-plugin-device-orientation (compass) plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-device-orientation
cordova-plugin-dialogs plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-dialogs
cordova-plugin-file plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-file
cordova-plugin-file-transfer plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-file-transfer
cordova-plugin-geolocation plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-geolocation
cordova-plugin-globalization plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-globalization
cordova-plugin-inappbrowser plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-inappbrowser
cordova-plugin-media plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-media
cordova-plugin-media-capture plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-media-capture
cordova-plugin-network-information plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-network-information
cordova-plugin-splashscreen plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-splashscreen
cordova-plugin-vibration plugman --platform <ios|amazon-fireos|android|blackberry10|wp8> --project --plugin cordova-plugin-vibration