App Center Distribute: actualizaciones desde la aplicación de Android

App Center Distribute permitirá a los usuarios instalar una nueva versión de la aplicación al distribuirla a través de App Center. Con una nueva versión de la aplicación disponible, el SDK presentará un cuadro de diálogo de actualización a los usuarios para descargar o posponer la nueva versión. Una vez que decidan actualizar, el SDK comenzará a actualizar la aplicación.

Adición de actualizaciones desde la aplicación a la aplicación

Siga la sección Introducción si aún no ha configurado e iniciado el SDK en la aplicación.

1. Agregar el módulo App Center Distribute

El SDK App Center está diseñado con un enfoque modular: un desarrollador solo necesita integrar los módulos de los servicios que les interesan.

1. Abra el archivo build.gradle del nivel de aplicación del proyecto ( ) y app/build.gradle agregue las siguientes líneas después de apply plugin .

   dependencies {
      def appCenterSdkVersion = '4.1.0'
      implementation "com.microsoft.appcenter:appcenter-distribute:${appCenterSdkVersion}"
   }
   

   Nota

   Si la versión del complemento Gradle de Android es inferior a 3.0.0, debe reemplazar la implementación por compile.

2. Guarde el archivo build.gradle y asegúrese de desencadenar una sincronización de Gradle Android Studio.

3. DownloadManager se usa para descargar actualizaciones. El SDK App Center aplica TLS 1.2 para mejorar la seguridad.

2. Iniciar App Center Distribute

Para usar App Center, opte por los módulos que desea usar. De forma predeterminada, no se inicia ningún módulo y debe llamar explícitamente a cada uno de ellos al iniciar el SDK.

Agregue la clase Distribute al AppCenter.start() método para iniciar App Center servicio Distribute.

AppCenter.start(getApplication(), "{Your App Secret}", Distribute.class);

AppCenter.start(application, "{Your App Secret}", Distribute::class.java)

Asegúrese de que ha reemplazado en {Your App Secret} el ejemplo de código anterior por el secreto de aplicación. Android Studio sugiere automáticamente la instrucción import necesaria una vez que agregue una referencia a la clase al método , pero si ve un error que indica que los nombres de clase no se reconocen, agregue las siguientes líneas a las instrucciones import de la clase Distribute start() de actividad:

import com.microsoft.appcenter.AppCenter;
import com.microsoft.appcenter.distribute.Distribute;

import com.microsoft.appcenter.AppCenter
import com.microsoft.appcenter.distribute.Distribute

Preparación de la Google Play compilación

Google Play considera que el código de actualización en la aplicación es un comportamiento malintencionado aunque no se utilice en tiempo de ejecución. Use una variante del SDK de distribución como se indica en esta sección o quite completamente el SDK de distribución que contiene el código de actualización en la aplicación antes de enviar la aplicación a Google Play. Si no lo hace, puede producirse un incumplimiento y la eliminación de la aplicación de Google Play. Para facilitarlo, proporcionamos la versión de App Center Distribute SDK con API con código auxiliar, por lo que el único cambio es un intercambio de dependencias.

1. Abra el archivo build.gradle del nivel de aplicación del proyecto ( app/build.gradle ).

2. Configure variantes de compilación mediante la adición de versiones de producto:

   android {
       flavorDimensions "distribute"
       productFlavors {
           appCenter {
               dimension "distribute"
           }
           googlePlay {
               dimension "distribute"
           }
       }
   }
   

3. Modifique el bloque de dependencias para consumir diferentes dependencias en función del tipo de producto:

   dependencies {
       def appCenterSdkVersion = "3.3.0"
       appCenterImplementation "com.microsoft.appcenter:appcenter-distribute:${appCenterSdkVersion}"
       googlePlayImplementation "com.microsoft.appcenter:appcenter-distribute-play:${appCenterSdkVersion}"
   }
   

4. Guarde el archivo build.gradle y asegúrese de desencadenar una sincronización de Gradle en Android Studio.

5. Puede cambiar la variante de compilación en el menú desplegable Build > Select Build Variant (Seleccionar variante de compilación) o Build Variants (Variantes de compilación) en la barra de la ventana de herramientas.

Puede leer más sobre la configuración de variantes de compilación en la documentación de Android.

Uso de un grupo de distribución privado

De forma predeterminada, Distribute usa un grupo de distribución público. Si desea usar un grupo de distribución privado, deberá establecerlo explícitamente a través de setUpdateTrack la API.

Distribute.setUpdateTrack(UpdateTrack.PRIVATE);

Distribute.setUpdateTrack(UpdateTrack.PRIVATE)

Cuando la aplicación está en primer plano (después de y ), se abre una ventana Distribute.setUpdateTrack(UpdateTrack.PRIVATE); del explorador para autenticar al AppCenter.start usuario. Todas las comprobaciones de actualización posteriores tendrán la versión más reciente en la pista privada.

Si un usuario está en la pista privada, significa que, después de la autenticación correcta, obtiene la versión más reciente de cualquier grupo de distribución privado del que sea miembro. Si un usuario está en la pista pública, significa que va a obtener la versión más reciente de cualquier grupo de distribución público.

Deshabilitar la comprobación automática de la actualización

De forma predeterminada, el SDK comprueba automáticamente si hay nuevas versiones:

• Cuando se inicia la aplicación.
• Cuando la aplicación entra en primer plano después de pasar a segundo plano.
• Al habilitar el módulo Distribute si se ha deshabilitado previamente.

Si desea buscar nuevas versiones manualmente, puede deshabilitar la comprobación automática de la actualización. Para ello, llame al método siguiente antes de que se inicie el SDK:

Distribute.disableAutomaticCheckForUpdate();

Distribute.disableAutomaticCheckForUpdate()

A continuación, puede usar checkForUpdate la API, que se describe en la sección siguiente.

Comprobación manual de la actualización

Distribute.checkForUpdate();

Distribute.checkForUpdate()

Esto envía una solicitud para App Center mostrar un cuadro de diálogo de actualización en caso de que haya una nueva versión disponible.

Personalización o localización del cuadro de diálogo de actualización en la aplicación

1. Personalización o localización de texto

Puede proporcionar fácilmente sus propias cadenas de recursos si desea cambiar o localizar el texto que se muestra en el cuadro de diálogo de actualización. Mire los archivos de cadena de este archivo de recursos. Use el mismo nombre o clave de cadena y especifique el valor localizado que se reflejará en el cuadro de diálogo en sus propios archivos de recursos de aplicación.

2. Personalización del cuadro de diálogo de actualización

Puede personalizar la apariencia del cuadro de diálogo de actualización predeterminado implementando la DistributeListener interfaz . Debe registrar el agente de escucha antes de llamar a AppCenter.start , como se muestra en el ejemplo siguiente:

Distribute.setListener(new MyDistributeListener());
AppCenter.start(...);

Distribute.setListener(MyDistributeListener())
AppCenter.start(...)

Este es un ejemplo de la implementación del agente de escucha que reemplaza el cuadro de diálogo del SDK por uno personalizado:

import android.app.Activity;
import android.app.AlertDialog;
import android.content.DialogInterface;
import android.net.Uri;

import com.microsoft.appcenter.distribute.Distribute;
import com.microsoft.appcenter.distribute.DistributeListener;
import com.microsoft.appcenter.distribute.ReleaseDetails;
import com.microsoft.appcenter.distribute.UpdateAction;

public class MyDistributeListener implements DistributeListener {

    @Override
    public boolean onReleaseAvailable(Activity activity, ReleaseDetails releaseDetails) {

        // Look at releaseDetails public methods to get version information, release notes text or release notes URL
        String versionName = releaseDetails.getShortVersion();
        int versionCode = releaseDetails.getVersion();
        String releaseNotes = releaseDetails.getReleaseNotes();
        Uri releaseNotesUrl = releaseDetails.getReleaseNotesUrl();

        // Build our own dialog title and message
        AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(activity);
        dialogBuilder.setTitle("Version " + versionName + " available!"); // you should use a string resource instead, this is just a simple example
        dialogBuilder.setMessage(releaseNotes);

        // Mimic default SDK buttons
        dialogBuilder.setPositiveButton(com.microsoft.appcenter.distribute.R.string.appcenter_distribute_update_dialog_download, new DialogInterface.OnClickListener() {

            @Override
            public void onClick(DialogInterface dialog, int which) {

                // This method is used to tell the SDK what button was clicked
                Distribute.notifyUpdateAction(UpdateAction.UPDATE);
            }
        });

        // We can postpone the release only if the update isn't mandatory
        if (!releaseDetails.isMandatoryUpdate()) {
            dialogBuilder.setNegativeButton(com.microsoft.appcenter.distribute.R.string.appcenter_distribute_update_dialog_postpone, new DialogInterface.OnClickListener() {

                @Override
                public void onClick(DialogInterface dialog, int which) {

                    // This method is used to tell the SDK what button was clicked
                    Distribute.notifyUpdateAction(UpdateAction.POSTPONE);
                }
            });
        }
        dialogBuilder.setCancelable(false); // if it's cancelable you should map cancel to postpone, but only for optional updates
        dialogBuilder.create().show();

        // Return true if you're using your own dialog, false otherwise
        return true;
    }
    
    @Override
    public void onNoReleaseAvailable(Activity activity) {
        Toast.makeText(activity, activity.getString(R.string.no_updates_available), Toast.LENGTH_LONG).show();
    }
}

import android.app.Activity
import android.app.AlertDialog
import com.microsoft.appcenter.distribute.Distribute
import com.microsoft.appcenter.distribute.DistributeListener
import com.microsoft.appcenter.distribute.ReleaseDetails
import com.microsoft.appcenter.distribute.UpdateAction

class MyDistributeListener : DistributeListener {

    override fun onReleaseAvailable(activity: Activity, releaseDetails: ReleaseDetails): Boolean {

        // Look at releaseDetails public methods to get version information, release notes text or release notes URL
        val versionName = releaseDetails.shortVersion
        val versionCode = releaseDetails.version
        val releaseNotes = releaseDetails.releaseNotes
        val releaseNotesUrl = releaseDetails.releaseNotesUrl

        // Build our own dialog title and message
        val dialogBuilder = AlertDialog.Builder(activity)
        dialogBuilder.setTitle("Version $versionName available!") // you should use a string resource instead, this is just a simple example
        dialogBuilder.setMessage(releaseNotes)

        // Mimic default SDK buttons
        dialogBuilder.setPositiveButton(
            com.microsoft.appcenter.distribute.R.string.appcenter_distribute_update_dialog_download
        ) { dialog, which ->
            // This method is used to tell the SDK what button was clicked
            Distribute.notifyUpdateAction(UpdateAction.UPDATE)
        }

        // We can postpone the release only if the update isn't mandatory
        if (!releaseDetails.isMandatoryUpdate) {
            dialogBuilder.setNegativeButton(
                com.microsoft.appcenter.distribute.R.string.appcenter_distribute_update_dialog_postpone
            ) { dialog, which ->
                // This method is used to tell the SDK what button was clicked
                Distribute.notifyUpdateAction(UpdateAction.POSTPONE)
            }
        }
        dialogBuilder.setCancelable(false) // if it's cancelable you should map cancel to postpone, but only for optional updates
        dialogBuilder.create().show()

        // Return true if you're using your own dialog, false otherwise
        return true
    }

    override fun onNoReleaseAvailable(activity: Activity) {
        Toast.makeText(activity, activity.getString(R.string.no_updates_available), Toast.LENGTH_LONG).show()
    }
}

Como se muestra en el ejemplo, debe llamar a Distribute.notifyUpdateAction(UpdateAction.UPDATE); o si el agente de escucha devuelve Distribute.notifyUpdateAction(UpdateAction.POSTPONE); true .

Si no llama a , la devolución de llamada notifyUpdateAction se repetirá en cada cambio de actividad.

Se puede llamar de nuevo al agente de escucha con la misma versión si la actividad cambia antes de que se notifique la acción del usuario al SDK.

Este comportamiento es necesario para cubrir los escenarios siguientes:

• La aplicación se envía a segundo plano (por ejemplo, presionando INICIO) y se reanuda en otra actividad.
• La actividad está cubierta por otra sin salir de la aplicación (como hacer clic en algunas notificaciones).
• Otros escenarios similares.

En ese caso, la actividad que hospeda el cuadro de diálogo podría reemplazarse sin interacción del usuario. Por lo tanto, el SDK llama de nuevo al agente de escucha para que pueda restaurar el cuadro de diálogo personalizado.

En los casos en los que el SDK busca actualizaciones y no encuentra ninguna actualización disponible más reciente que la que se usa actualmente, se invoca una devolución de llamada de onNoReleaseAvailable DistributeListener interfaz from. Esto le permite ejecutar código personalizado en estos escenarios. En el ejemplo anterior se muestra cómo mostrar el mensaje del sistema cuando no se encuentra ninguna actualización.

Habilitación o deshabilitación App Center Distribute en tiempo de ejecución

Puede habilitar y deshabilitar la App Center distribute en tiempo de ejecución. Si lo deshabilita, el SDK no proporcionará ninguna funcionalidad de actualización en la aplicación, pero puede seguir utilizando el servicio Distribute en App Center portal.

Distribute.setEnabled(false);

Distribute.setEnabled(false)

Para habilitar App Center Distribute de nuevo, use la misma API, pero pase true como parámetro.

Distribute.setEnabled(true);

Distribute.setEnabled(true)

El estado se conserva en el almacenamiento del dispositivo en los inicios de la aplicación.

Esta API es asincrónica, puede leer más sobre esto en nuestra guía App Center API asincrónicas.

Compruebe si App Center Distribute está habilitado

También puede comprobar si App Center Distribute está habilitado o no:

Distribute.isEnabled();

Distribute.isEnabled()

Esta API es asincrónica, puede leer más sobre esto en nuestra guía App Center API asincrónicas.

Habilitación de actualizaciones en la aplicación para compilaciones de depuración

De forma App Center habilita las actualizaciones en la aplicación solo para las compilaciones de versión.

Para habilitar las actualizaciones en la aplicación en compilaciones de depuración, llame al método siguiente antes de AppCenter.start :

Distribute.setEnabledForDebuggableBuild(true);

Distribute.setEnabledForDebuggableBuild(true)

¿Cómo funcionan las actualizaciones desde la aplicación?

La característica de actualizaciones en la aplicación funciona de la siguiente manera:

1. Esta característica solo funciona con compilaciones RELEASE (de forma predeterminada) que se distribuyen mediante App Center servicio Distribute.

2. Una vez que integre el SDK, compile la versión de lanzamiento de la aplicación y cargue en App Center, se notificará a los usuarios de ese grupo de distribución la nueva versión a través de un correo electrónico.

3. Cuando cada usuario abra el vínculo en su correo electrónico, la aplicación se instalará en su dispositivo. Es importante que usen el vínculo de correo electrónico para la instalación; no se admite la carga lateral. Cuando se descarga una aplicación desde el vínculo, el SDK guarda información importante de las cookies para buscar actualizaciones más adelante; de lo contrario, el SDK no tiene esa información clave.

4. Si la aplicación establece la pista en privada, se abrirá un explorador para autenticar al usuario y habilitar las actualizaciones en la aplicación. El explorador no se volverá a abrir mientras la información de autenticación siga siendo válida incluso cuando vuelva a la pista pública y vuelva a ser privada más adelante. Si la autenticación del explorador se realiza correctamente, se redirige automáticamente al usuario a la aplicación. Si la pista es pública (que es el valor predeterminado), el paso siguiente se produce directamente.

5. Una nueva versión de la aplicación muestra el cuadro de diálogo de actualización desde la aplicación en el que se pide a los usuarios que actualicen la aplicación si es:

   • un valor mayor de versionCode o
   • un valor igual de versionCode pero un valor diferente de versionName .

Cómo probar las actualizaciones en la aplicación?

Debe cargar compilaciones de versión (que usan el módulo Distribute del SDK de App Center) en App Center Portal para probar las actualizaciones en la aplicación, lo que aumenta los números de versión cada vez.

1. Cree la aplicación en App Center Portal si aún no lo ha hecho.
2. Cree un nuevo grupo de distribución y así poder reconocer que está diseñado para probar la característica de actualización en la aplicación.
3. Agregue usted mismo (o todas las personas que quiera incluir en la prueba de la característica de actualización en la aplicación). Use una dirección de correo electrónico nueva o de lanzamiento para esto, que no se usó para esa aplicación en App Center. Esto garantiza que la experiencia esté cerca de la experiencia de los evaluadores reales.
4. Cree una nueva compilación de la aplicación que incluya App Center Distribute y contenga la lógica de configuración como se ha descrito anteriormente. Si el grupo es privado, no olvide establecer la pista de actualización privada en la aplicación antes de empezar a usar la API setUpdateTrack.
5. Haga clic en el botón Distribuir nueva versión en el portal y cargue la compilación de la aplicación.
6. Una vez finalizada la carga, haga clic en Siguiente y seleccione el grupo Distribución que creó como Destino de esa distribución de aplicaciones.
7. Revise la distribución y distribuya la compilación al grupo de pruebas en la aplicación.
8. Los usuarios de ese grupo recibirán una invitación para ser evaluadores de la aplicación. Una vez que acepten la invitación, pueden descargar la aplicación desde App Center Portal desde su dispositivo móvil. Una vez que tengan instaladas las actualizaciones en la aplicación, estará listo para probar las actualizaciones en la aplicación.
9. versionCodeProtuberancia de la aplicación.
10. Compile la versión de lanzamiento de la aplicación y cargue una nueva compilación de la aplicación como hizo en el paso anterior y distribúyala en el grupo de distribución que creó anteriormente. La próxima vez que se inicie la aplicación, se solicitará a los miembros del grupo de distribución una nueva versión.