Introducción con Apache Cordova

Nota

La compatibilidad con las aplicaciones de Cordova finaliza en abril de 2022. Busque más información en el blog App Center.

El SDK App Center usa una arquitectura modular para que pueda usar fácilmente uno, varios o todos los servicios de App Center en la Apache Cordova aplicación.

En este artículo, aprenderá a agregar el SDK de App Center a las aplicaciones de Apache Cordova y, a continuación, configurará las funcionalidades de App Center Analytics y App Center Crashes en una aplicación.

1. Prerrequisitos

Antes de comenzar, asegúrese de que el proyecto Apache Cordova aplicación cumple los siguientes requisitos mínimos:

  • Cordova CLI 6.4.0 o posterior
  • cordova-android motor 5.0.0 o posterior
  • cordova-ios motor 4.3.0 o posterior

Para determinar la versión Cordova CLI, abra una ventana de terminal o Windows símbolo del sistema y ejecute el siguiente comando:

cordova -v

Para determinar las versiones y , abra el archivo deconfig.xmldel proyecto, encontrará los motores de plataforma definidos en los elementos que se muestran cordova-android cordova-ios a engine continuación:

<engine name="android" spec="~6.2.3" />
<engine name="ios" spec="~4.4.0" />

También debe tener CocoaPods instalado. Para ello, ejecute sudo gem install cocoapods pod setup

2. Obtención del secreto App Center aplicación

Para que el SDK de App Center se conecte con el proyecto de aplicación en App Center, el SDK necesita el secreto de aplicación del proyecto de App Center. Más adelante aprenderá a configurar el SDK de App Center Apache Cordova con este valor, pero por ahora, veamos dónde encontrarlo.

Si ya tiene un proyecto de App Center, acceda al panel deApp Center y abra el proyecto. También puede usar el secreto de la aplicación en la página de Configuración aplicación. Acceda al menú de la esquina superior derecha de la página y seleccione Copiar secreto de aplicación para copiar el secreto de la aplicación en el Portapapeles.

Si no tiene una aplicación creada en el panel de App Center, complete los pasos siguientes.

  1. Regístrese para obtener una App Center o inicie sesión en una cuenta de App Center existente en https://appcenter.ms .
  2. En el panel App Center, haga clic en el menú desplegable Agregar nuevo en la esquina superior derecha de la página. Seleccione Agregar nueva aplicación en el menú.
  3. Escriba un nombre para el proyecto de aplicación y agregue una descripción opcional según sea necesario.
  4. Seleccione el sistema operativo adecuado para el proyecto de aplicación (solo Android o iOS) y, a continuación, seleccione la opción de plataforma Cordova.
  5. Haga clic en el botón Agregar nueva aplicación en la esquina inferior derecha de la página.
  6. Busque el secreto de la aplicación en la página de Configuración aplicación. Acceda al menú de la esquina superior derecha de la página y seleccione el elemento Copy app secret (Copiar secreto de aplicación) para copiar el secreto de la aplicación en el Portapapeles.

3. Agregar el SDK App Center al proyecto

Instalar el SDK

Para Apache Cordova proyectos, el SDK se distribuye a través de complementos Apache Cordova estándar. Agregue el SDK App Center a su proyecto de Cordova con las instrucciones proporcionadas en esta sección. Para empezar, abra una ventana de Terminal Windows símbolo del sistema y, a continuación, vaya a la carpeta raíz del proyecto de Cordova.

Para agregar compatibilidad con App Center Analytics al proyecto, ejecute el siguiente comando:

cordova plugin add cordova-plugin-appcenter-analytics

Para agregar compatibilidad con App Center bloqueos al proyecto, ejecute el siguiente comando:

cordova plugin add cordova-plugin-appcenter-crashes

Para agregar complementos para todas las funcionalidades de App Center al proyecto con un comando, ejecute el siguiente comando:

cordova plugin add cordova-plugin-appcenter-analytics cordova-plugin-appcenter-crashes

Nota

Debe agregar cordova-plugin-appcenter-analytics y cordova-plugin-appcenter-crashes la mayoría de todas las aplicaciones que usan App Center; proporcionan información útil para los desarrolladores sin ninguna configuración ni codificación adicionales.

Configuración de los complementos

Secreto de la aplicación

Debe configurar el proyecto con el secreto de aplicación App Center proyecto para poder usar el SDK de App Center en el Apache Cordova proyecto.

Abra el Apache Cordova archivo de config.xml proyecto; Para cada uno de los Apache Cordova de destino del proyecto (actualmente solo Android e iOS), agregue un elemento secundario platform preference en el formato siguiente:

<preference name="APP_SECRET" value="0000-0000-0000-0000-000000000000" />

En este ejemplo, va a agregar un elemento con un atributo con un valor de y un atributo con el name valor que se muestra en el APP_SECRET value ejemplo. En este caso, el que se muestra en el ejemplo es una representación arbitraria de un secreto App Center 0000-0000-0000-0000-000000000000 aplicación de proyecto. Reemplace el secreto de aplicación que se muestra en el ejemplo por el secreto de aplicación real del App Center proyecto.

Como ejemplo completo, para un proyecto de Apache Cordova que admite destinos Android e iOS, tendrá definiciones de proyecto de aplicación independientes en App Center, y así, diferentes valores de secreto de aplicación para cada plataforma de destino. La sección pertinente del archivo de config.xml proyecto tendrá un aspecto parecido al siguiente:

<platform name="android">
   <preference name="APP_SECRET" value="0000-0000-0000-0000-000000000001" />
</platform>
<platform name="ios">
   <preference name="APP_SECRET" value="0000-0000-0000-0000-000000000002" />
</platform>

Nota

En el ejemplo no se muestran los valores reales del secreto de la aplicación; se trata simplemente de simulaciones, tendrá que tomar los secretos de la aplicación App Center proyecto y usarlos aquí. Los secretos de la aplicación son diferentes porque tendrá secretos únicos para los proyectos de aplicación de iOS y Android en App Center.

Preferencias de Análisis

Si usa App Center Analytics en la aplicación, hay que realizar algunos pasos de configuración adicionales. Abra el Apache Cordova archivo de config.xmldel proyecto en un editor y agregue uno o varios de los siguientes elementos preferences al archivo:

  • APPCENTER_ANALYTICS_ENABLE_IN_JS - (opcional, el valor predeterminado es false) Controla si Analytics está habilitado automáticamente. Cuando false es , Analytics está habilitado de forma predeterminada. Cuando true es , la aplicación debe llamar a (en su código JavaScript) para habilitar Analytics antes AppCenter.Analytics.setEnabled(true) de enviar datos a App Center. Esta preferencia es útil cuando se quiere preguntar a los usuarios si quieren compartir información de análisis antes de habilitarla dentro de la aplicación. Obtenga más información sobre el envío manual de eventos de usuario.

    Ejemplo:

    <preference name="APPCENTER_ANALYTICS_ENABLE_IN_JS" value="true" />
    
  • APPCENTER_CRASHES_ALWAYS_SEND - (opcional, el valor predeterminado es true) Especifica si los informes de bloqueo se envían automáticamente a App Center cuando se bloquea la aplicación. Al enviar informes de bloqueo automáticamente, se notifican todos los bloqueos, lo que podría sobresalar a los equipos de ingeniería y soporte técnico. Al enviar informes de bloqueo manualmente (estableciendo en ), el código dentro de la aplicación puede determinar los bloqueos y decidir cuándo se envían los informes de bloqueo a App Center, qué datos se incluyen en los informes, y así APPCENTER_CRASHES_ALWAYS_SEND false sucesivamente. Esto significa más trabajo para el desarrollador, pero también proporciona un mayor control sobre la privacidad del usuario y permite adjuntar un mensaje con un informe de bloqueo. Obtenga más información sobre el procesamiento de informes de bloqueo en JS.

    Ejemplo:

    <preference name="APPCENTER_CRASHES_ALWAYS_SEND" value="false" />
    

    Si usa la copia de seguridad automática para evitar obtener información incorrecta sobre los dispositivos, siga estos pasos:

Nota

Las aplicaciones destinadas a Android 6.0 (nivel de API 23) o superior tienen la copia de seguridad automática habilitada automáticamente.

Nota

Si ya tiene un archivo personalizado con regla de copia de seguridad, cambie al tercer paso.

a. Cree appcenter_backup_rule.xml archivo en la carpeta res/xml.

<resource-file src="appcenter_backup_rule.xml" target="res/xml/appcenter_backup_rule.xml" />

b. Para que el atributo se agregue al elemento dentro deAndroidManifest.xml, agregue las líneas siguientes al archivo deconfig.xmlandroid:fullBackupContent <application> aplicación:

<edit-config file="app/src/main/AndroidManifest.xml" mode="merge" target="/manifest/application">
     <application android:fullBackupContent="@xml/appcenter_backup_rule" />
</edit-config>
 ```

c. Add the following backup rules to the **appcenter_backup_rule.xml** file:

```xml
<full-backup-content xmlns:tools="http://schemas.android.com/tools">
   <exclude domain="sharedpref" path="AppCenter.xml"/>
   <exclude domain="database" path="com.microsoft.appcenter.persistence"/>
   <exclude domain="database" path="com.microsoft.appcenter.persistence-journal"/>
   <exclude domain="file" path="error" tools:ignore="FullBackupContent"/>
   <exclude domain="file" path="appcenter" tools:ignore="FullBackupContent"/>
</full-backup-content>

4. ¿Dónde ir a continuación?

Excelente, todo está listo para visualizar los datos de Análisis y bloqueos recopilados automáticamente por el SDK en el portal. No se requiere ninguna configuración adicional. Consulte las secciones Análisis y bloqueos para obtener guías y tutoriales de API para aprender App Center puede hacer.