Cómo migrar servicios en primer plano a tareas de transferencia de datos iniciados por el usuario

Android 14 aplica reglas estrictas sobre cuándo las apps pueden usar servicios en primer plano.

Además, en Android 14, presentamos una nueva API para especificar que una tarea debe ser una de transferencia de datos que inicia el usuario. Esta API es útil para los casos de uso que requieran transferencias de datos de mayor duración iniciadas por el usuario, como descargar un archivo desde un servidor remoto. Estos tipos de tareas deben usar una tarea de transferencia de datos que inicia el usuario.

Estas tareas de transferencia de datos son iniciadas por el usuario. Estas tareas requieren una notificación, comienzan de inmediato y pueden ejecutarse durante un período prolongado si las condiciones del sistema lo permiten. Se pueden ejecutar varias tareas de transferencia de datos iniciadas por el usuario al mismo tiempo.

Se deben programar las tareas iniciadas por el usuario mientras la aplicación sea visible para él (o en una de las condiciones permitidas). Después de que se cumplen todas las restricciones, el SO puede ejecutar las tareas iniciadas por el usuario, sujeto a las limitaciones del estado del sistema. Es posible que el sistema también utilice el tamaño indicado de la carga útil estimada para determinar la duración de la tarea.

Permiso para tareas de transferencia de datos que inicia el usuario

Las tareas de transferencia de datos que inicia el usuario requieren un permiso nuevo para ejecutarse: RUN_USER_INITIATED_JOBS. El sistema otorga este permiso automáticamente. El sistema arroja una SecurityException si no declaras el permiso en el manifiesto de la app.

Proceso para programar tareas de transferencia de datos que inicia el usuario

Para ejecutar una tarea que inicia el usuario, haz lo siguiente:

  1. Si es la primera vez que declaras una API con JobScheduler, declara el JobService y los permisos asociados en tu manifiesto. Además, define una subclase concreta de JobService para tu transferencia de datos:

    <service android:name="com.example.app.CustomTransferService"
            android:permission="android.permission.BIND_JOB_SERVICE"
            android:exported="false">
            ...
    </service>
    
    class CustomTransferService : JobService() {
      ...
    }
    
  2. Declara el permiso RUN_USER_INITIATED_JOBS en tu manifiesto:

    <manifest ...>
        <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
        <application ...>
            ...
        </application>
    </manifest>
    
  3. Llama al nuevo método setUserInitiated() cuando compiles un objeto JobInfo. También se recomienda que ofrezcas una estimación del tamaño de la carga útil mediante una llamada a setEstimatedNetworkBytes() durante la creación del trabajo:

    val networkRequestBuilder = NetworkRequest.Builder()
            .addCapability(NET_CAPABILITY_INTERNET)
            .addCapability(NET_CAPABILITY_NOT_METERED)
            // Add or remove capabilities based on your requirements
            .build()
    
    val jobInfo = JobInfo.Builder()
            // ...
            .setUserInitiated(true)
            .setRequiredNetwork(networkRequestBuilder.build())
            .setEstimatedNetworkBytes(1024 * 1024 * 1024)
            // ...
            .build()
    
  4. Programa el trabajo antes de que comience la transferencia, mientras la aplicación está visible o en la lista de condiciones permitidas:

    val jobScheduler: JobScheduler =
        context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
    jobScheduler.schedule(jobInfo)
    
  5. Cuando se ejecute la tarea, asegúrate de llamar a setNotification() en el objeto JobService. Este valor se usa para informarle al usuario que la tarea está en ejecución, tanto en el Administrador de tareas como en el área de notificaciones de la barra de estado:

    class CustomTransferService : JobService() {
      override fun onStartJob(params: JobParameters?): Boolean {
          val notification = Notification.Builder(applicationContext, NOTIFICATION_CHANNEL_ID)
                  .setContentTitle("My user-initiated data transfer job")
                  .setSmallIcon(android.R.mipmap.myicon)
                  .setContentText("Job is running")
                  .build()
    
          setNotification(params, notification.id, notification,
                  JobService.JOB_END_NOTIFICATION_POLICY_DETACH)
          // Do the job execution.
      }
    }
    
  6. Actualiza la notificación de forma periódica para mantener informado al usuario sobre el estado y el progreso de la tarea. Si no puedes determinar el tamaño de transferencia antes de programar el trabajo o necesitas actualizar el tamaño de transferencia estimado, usa la API nueva, updateEstimatedNetworkBytes(), para actualizar el tamaño de transferencia una vez que se haga conocido.

  7. Cuando finalice la ejecución, llama a jobFinished() para indicarle al sistema que se completó la tarea o que se debe reprogramar.

Cómo detener las tareas de transferencia de datos que inicia el usuario

El usuario y el sistema pueden detener tareas de transferencia que inicia el usuario.

Por el usuario, desde el Administrador de tareas

El usuario puede detener una tarea de transferencia de datos que inicia él mismo y que aparece en el Administrador de tareas.

En el momento en que el usuario presiona Detener, el sistema hace lo siguiente:

  • Finaliza el proceso de tu app de inmediato, incluidos todas las demás tareas o servicios en primer plano que se ejecutan.
  • No llama a onStopJob() para ninguna tarea en ejecución.
  • Previene la reprogramación de las tareas visibles para el usuario.

Por estos motivos, te recomendamos que proporciones controles en la notificación publicada para la tarea para permitir que se detenga y se reprograme la tarea con facilidad.

Ten en cuenta que, en circunstancias especiales, el botón Detener no aparece junto a la tarea en el Administrador de tareas, o la tarea no se muestra en el Administrador en absoluto.

Por el sistema

A diferencia de las tareas normales, las de transferencia de datos que inicia el usuario no se ven afectadas por las cuotas de los buckets de App Standby. Sin embargo, el sistema detiene la tarea si se produce alguna de las siguientes condiciones:

  • Ya no se cumple una restricción que define el desarrollador.
  • El sistema determina que la tarea se ejecutó más tiempo del necesario para completar la tarea de transferencia de datos.
  • El sistema debe priorizar el estado del sistema y detener las tareas debido al aumento del estado térmico.
  • El proceso de la app finaliza debido a la poca memoria del dispositivo.

Cuando el sistema detiene la tarea (pero no por la poca memoria del dispositivo), el sistema llama a onStopJob() y vuelve a intentar la tarea en un momento que considera óptimo. Verifica que tu app pueda conservar el estado de transferencia de datos, incluso si no se llama a onStopJob(), y que tu app pueda restablecer este estado cuando se vuelva a llamar a onStartJob().

Condiciones permitidas para programar tareas de transferencia de datos que inicia el usuario

Las apps solo pueden comenzar una tarea de transferencia de datos que inicie el usuario si estas están en la ventana visible o si se cumplen ciertas condiciones. Para determinar cuándo se puede programar una tarea de transferencia de datos que inicia el usuario, el sistema aplica la misma lista de condiciones que permiten que las apps comiencen una actividad en segundo plano en casos especiales. En particular, esta lista de condiciones no es la misma que el conjunto de exenciones para las restricciones del servicio en primer plano que se inician en segundo plano.

Las excepciones a la declaración anterior son las siguientes:

  • Si una app puede iniciar actividades en segundo plano, también puede iniciar tareas de transferencia de datos que inicie el usuario en segundo plano.
  • Si una app tiene una actividad en la pila de actividades de una tarea existente en la pantalla Recientes, eso solo no permite que se ejecute una tarea de transferencia de datos que inicia el usuario.

Si la tarea está programada en algún otro momento que no esté en la lista de condiciones permitidas, la tarea falla y muestra un código de error RESULT_FAILURE.

Restricciones permitidas para las tareas de transferencia de datos que inicia el usuario

Para admitir las tareas que se ejecutan en puntos óptimos, Android ofrece la capacidad de asignar restricciones a cada tipo de tarea. Estas restricciones ya están disponibles a partir de Android 13.

Nota: En la siguiente tabla, solo se comparan las restricciones que varían entre cada tipo de tarea. Consulta la página del desarrollador de JobScheduler o las restricciones de tareas para conocer todas las restricciones.

En la siguiente tabla, se muestran los diferentes tipos de tareas que admiten una restricción de tarea determinada, así como el conjunto de restricciones de tareas que admite WorkManager. Usa la barra de búsqueda antes de la tabla para filtrarla por el nombre de un método de restricción de tarea.

Estas son las restricciones permitidas para las tareas de transferencia de datos que inicia el usuario:

  • setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
  • setClipData()
  • setEstimatedNetworkBytes()
  • setMinimumNetworkChunkBytes()
  • setPersisted()
  • setNamespace()
  • setRequiredNetwork()
  • setRequiredNetworkType()
  • setRequiresBatteryNotLow()
  • setRequiresCharging()
  • setRequiresStorageNotLow()

Pruebas

En la siguiente lista, se muestran algunos pasos para probar las tareas de tu app de forma manual:

  • Para obtener el ID de tarea, consigue el valor que se define en la tarea que se está compilando.
  • Para ejecutar una tarea de inmediato o volver a intentar una tarea detenida, ejecuta el siguiente comando en una ventana de terminal:

    adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
    
  • Para simular que el sistema detiene, de manera forzosa, una tarea (debido al estado de este o a las condiciones de falta de cuota), ejecuta el siguiente comando en una ventana de terminal:

    adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID