Gerenciar plug-ins para aplicativos compilados com o Visual Studio Tools for Apache Cordova

Artigo
09/13/2015

No Visual Studio 2013, as ferramentas do Cordova são lançadas como uma versão de visualização (CTP). As ferramentas do Cordova serão lançadas como parte do Visual Studio 2015 e recomendamos usar o Visual Studio 2015 RTM para desenvolver aplicativos usando o Visual Studio Tools for Apache Cordova. Você pode baixar o Visual Studio no Centro de Download da Microsoft.

O Apache Cordova plug-ins para oferecer acesso a recursos de dispositivo nativos que não estão disponíveis para aplicativos da web simples, como o acesso ao sistema de arquivos. Um plug-in é uma biblioteca do Cordova entre plataformas que acessa código nativos e recursos de dispositivo por meio de uma interface de JavaScript. Quando necessário, o plug-in também atualiza o manifesto de plataforma para habilitar os recursos do dispositivo. Nem todos os plug-ins são suportados ou necessários em todas as plataformas de dispositivo.

Habilite os plug-ins usando o arquivo config.xml do Cordova. O Visual Studio fornece maneiras de atualizar este arquivo usando o designer de configuração. Para gerenciar os plug-ins no aplicativo Cordova:

Use o designer de configuração do Visual Studio paraAdicionar um plug-inprincipal conjunto de plug-ins Cordova ou adicionar um plug-in personalizado
Use o designer de configuração paraatualizar um plug-in.
Editar o arquivo config. XML paraAdicionar um plug-inque não está presente no designer de configuração.
Editar o arquivo config. XML paraespecificar parâmetros de plug-in.
Estender ou criar um plug-in personalizado

Dica

Para ver os plug-ins de núcleo disponíveis no designer de configuração, consultelista de plug-ins disponíveis.Para obter mais informações sobre plug-ins, consulte o Documentação do config.xml do Cordova.

Adicionando um plug-in

Você pode adicionar um plug-in do núcleo Cordova ou um plug-in personalizado, usando o Visual Studio. Você também pode consultar os plug-ins adicionais do registro Cordova editando o config.xml. Quando você cria uma solução, o plug-in é instalado do registro do Cordova.

Para adicionar um plug-in no designer de configuração do Visual Studio

No Gerenciador de Soluções, abra o menu de atalho para o arquivo config.xml e escolha Abrir ou Ver designer.
No designer de configuração, escolha a guia Plug-ins.
Selecione o tipo de plug-in que você deseja habilitar no seu aplicativo (ambosCoreoupersonalizado). (Consulte olista de plug-ins disponíveis.)
- Para adicionar um plug-in do principal, selecione o plug-in e escolhaAdd.
- Para adicionar um plug-in personalizado, especifiqueLocalouGitcomo a origem e, em seguida, forneça o local da navegação ou especificando um repositório Git, conforme indicado.
  
  Por exemplo, aqui está o repositório para PushPlugin: https://github.com/phonegap-build/PushPlugin.git
A ilustração a seguir mostra a seleção de um plug-in do núcleo no designer de configuração.

A ilustração a seguir mostra como adicionar um plug-in personalizado de um repositório Git no designer de configuração.
Quando você adicionar o plug-in, o Visual Studio também faz alterações no seu arquivo config. XML.

Para obter mais informações a edição do config.xml, consulte a Documentação do config.xml do Cordova.

Quando você adiciona um plug-in personalizado, o Visual Studio também adiciona a estrutura de pastas e arquivos de plug-in no projeto noPlug-inspasta. Os arquivos de plug-in importantes incluem: plugin.xml, pasta de origem do plug-in e da pasta de www do plug-in.

Para remover um plug-in, localizar o plug-in no designer de configuração e escolherRemover.

Se ocorrerem erros de adição de um plug-in, consulte estesdicas e soluções alternativas.

Para escrever código para um plug-in específico, consulte a Referência da API do Cordova.

Atualizando um plug-in

Use o designer de configuração para um plug-in de atualização para uma versão mais recente. O designer de configuração adiciona sempre a versão mais recente de um plug-in no seu projeto quando ele é instalado. Para atualizar, basta remover o plug-in e adicioná-lo novamente.

O registro de plug-ins do Cordova fornece informações sobre as diferentes versões de plug-in.

Adicionar um plug-in não está presente no designer de configuração

Ocasionalmente, talvez seja necessário instalar uma versão específica de um plug-in Cordova que não esteja listado no designer de configuração. Se este plug-in está disponível em plugins.cordova.io ao usar qualquer versão do Cordova ou em npm ao usar Cordova 5.0.0+, você pode adicionar o elemento a seguir ao arquivo config. XML e o plug-in será instalado na próxima compilação:

Para adicionar o plug-in

Se qualquer um dos plug-ins que você pretende instalar já foram adicionados ao seu projeto (particularmente com uma identificação mais antigo), removê-los usando a aba instalado da seção Plug-ins do designer de configuração no Visual Studio.
No Solution Explorer, abra o menu de atalho para o arquivo config. XML e escolhaExibir código.
Adicione o seguinte elemento ao arquivo config. XML no elemento raiz widget:
```
<vs:plugin name="org.apache.cordova.pluginname" version="0.1.1" />
```
e substituaorg.apache.cordova.pluginnamecom a ID correta e substitua 0.1.1 com a versão correta.

O plug-in será instalado na próxima vez que você cria o aplicativo.

Você pode adicionar plug-ins usando um URI gito ou o sistema de arquivos local usando a guia personalizada da seção Plug-ins no designer de config. XML. Usando um URI gito pode causar obter uma versão de "desenvolvimento" de um plug-in. Consulteestas instruçõesse você quiser usar uma versão específica de um plug-in do GitHub originado.

Configurando parâmetros de plug-in

Quando você estiver adicionando um plug-in usando o designer de configuração, você também pode especificar parâmetros de plug-in na interface do usuário. No entanto, ao adicionar um plug-in não está presente no designer de configuração (editando config. xml), você também pode especificar parâmetros usando alguns elementos XML adicionais.

Por exemplo, para configurar o plug-in do Facebook, você pode editar os parâmetros a seguir no arquivo 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>

Isso tem o mesmo resultado executando o seguinte comando na linha de comando (se você não estava usando o Visual Studio):

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

Importante

Cordova 4.3.1 e em versões anteriores têm um conjunto de problemas conhecidos que podem impedir que o plug-ins com parâmetros de funcionar corretamente.É recomendável usar Cordova 5.1.1 ou posteriores ao usar plug-ins que exigem parâmetros.

Estendendo um plug-in personalizado

Às vezes, os plug-ins personalizados no registro Cordova podem não atender a todos os seus requisitos de aplicativo, e você talvez queira estender um plug-in ou criar seu próprio plug-in. Por exemplo, se você precisar transferir funções dispendiosas para código nativo, expor os novos recursos de dispositivo ao seu aplicativo ou aplicar uma correção para um plug-in existente que você não desejar liberar publicamente, talvez queira estender ou criar um plug-in. Você pode encontrar mais informações sobre como criar seu próprio plug-in no guia de desenvolvimento de plug-in na documentação do Cordova.

Se você precisa estender seu aplicativo usando um plug-in personalizado, verifique primeiro o registro do plug-in e use o código que outras pessoas escreveram. Se um plug-in existente está perto o que você precisa, baixá-lo, fazer melhorias e, em seguida, enviar as alterações ao autor original. Isso é uma ótima maneira de dar retorno à comunidade Cordova e tornando mais fácil para outras pessoas solucionar problemas semelhantes.

Instale o plug-in personalizado usando o designer de configuração. Quando o arquivo plugin.xml ao lado da pasta da Web na árvore da pasta do projeto, os arquivos JavaScript necessários da pasta de www do plug-in serão carregados automaticamente em tempo de execução. Você não precisa fazer referência a esses arquivos de um arquivo HTML. Você também pode definir pontos de interrupção dentro desses arquivos de código, se necessário. O processo de compilação também compila quaisquer arquivos específicos de plataforma na pasta src.

Lista de plug-ins disponíveis no designer de configuração

Os seguintes plug-ins estão disponíveis usando o Designer de Configuração:

Acelerômetro / Movimento de Dispositivo (org.apache.cordova.device-motion)

Fornece acesso a um sensor de movimento que detecta alterações na movimentação em relação à orientação do dispositivo.
Cliente de Serviços Móveis do Azure (com.msopentech.azure-mobile-services)

Adiciona a biblioteca cliente de Serviços Móveis do Azure apropriada ao seu aplicativo para cada plataforma e permite que o aplicativo sincronize o conteúdo com uma instância dos Serviços Móveis do Azure.
Status da bateria (Android, iOS e Windows Phone 8) (org.apache.cordova.battery-status)

Permite que o aplicativo lide com um evento é disparado quando a carga disponível na bateria aumenta ou diminui em pelo menos 1%, ou quando o dispositivo é conectado ou desconectado de uma tomada elétrica.
Câmera (org.apache.cordova.camera)

Permite que seu aplicativo obtenha imagens usando o aplicativo de câmera padrão do dispositivo.
Bússola (org.apache.cordova.device-orientation)

Fornece acesso a um sensor que detecta a direção ou a parte superior do dispositivo com base no que forma o dispositivo está apontado.
Conexão (org.apache.cordova.network-information)

Permite que o aplicativo determine o estado da conexão de rede do dispositivo e os tipos de redes às quais o dispositivo está conectado.
Console (org.apache.cordova.console)

Fornece uma implementação diferente de console.log (para uso como uma solução alternativa para problemas de console.log).
Contatos (org.apache.cordova.contacts)

Fornece acesso ao banco de dados de Contatos do dispositivo. Seu aplicativo pode encontrar, adicionar ou remover contatos.
Dispositivo (org.apache.cordova.device)

Fornece acesso a informações sobre o hardware e o software do dispositivo. Por exemplo, isso pode ser o número do modelo ou a plataforma do dispositivo.
Diálogos / Notificações (org.apache.cordova.dialogs)

Permite que seu aplicativo exiba caixas de diálogo.
Sistema de Arquivos (org.apache.cordova.file)

Permite que seu aplicativo leia, grave e navegue pelo sistema de arquivos do dispositivo.
Transferência de Arquivos (org.apache.cordova.file-transfer)

Permite que seu aplicativo carregue ou baixe arquivos para o servidor ou vindos dele.
Geolocalização (org.apache.cordova.geolocation)

Fornece informações sobre o local do dispositivo, como latitude e longitude.
Globalização (org.apache.cordova.globalization)

Permite que o aplicativo obtenha informações sobre a localidade do usuário e seu fuso horário e, em seguida, execute operações que são específicas para esta localidade e fuso horário.
InAppBrowser (org.apache.cordova.inappbrowser)

Permite que o aplicativo hospede um navegador da web e, em seguida, execute ações em resposta a eventos relacionados ao navegador, como inserir CSS na janela do navegador quando uma página é carregada, por exemplo.

Dica

Atualmente, não há suporte para anexar o depurador a aplicativos do iOS que usam o plug-in InAppBrowser.O plug-in de serviços móveis do Azure usa o plug-in InAppBrowser e é afetado por essa limitação.
Mídia (org.apache.cordova.media)

Permite que seu aplicativo reproduza e grave arquivos de áudio usando o aplicativo padrão do dispositivo.
Captura de Mídia (org.apache.cordova.media-capture)

Fornece acesso aos recursos de captura de áudio, imagem e vídeo do dispositivo.
Splashscreen (org.apache.cordova.splashscreen)

Permite que o aplicativo mostre e oculte a tela inicial.
Vibração (org.apache.cordova.vibration)

Permite que o aplicativo vibre o dispositivo.
WebSQL Polyfill (Windows e Windows Phone 8) (com.msopentech.websql)

Permite o WebSQL em todas as plataformas adicionando a funcionalidade WebSQL ao aplicativo no Windows e Windows Phone 8.