Transferencia de datos que inicia el usuario

Si necesitas realizar una transferencia de datos que puede tardar mucho tiempo, puedes crear un trabajo de JobScheduler y, luego, identificarlo como un trabajo de transferencia de datos iniciada por el usuario (UIDT). Los trabajos de UIDT están diseñados para transferencias de datos de mayor duración que inicia el usuario del dispositivo, como descargar un archivo desde un servidor remoto. Los trabajos de UIDT se introdujeron con Android 14 (nivel de API 34).

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.

Cómo programar tareas de transferencia de datos que inicia el usuario

To run a user initiated data-transfer job, do the following:

  1. Make sure your app has declared the JobService and associated permissions in its manifest:

    <service android:name="com.example.app.CustomTransferService"
        android:permission="android.permission.BIND_JOB_SERVICE"
        android:exported="false">
        ...
</service>

    Also, define a concrete subclass of JobService for your data transfer:

    Kotlin

    class CustomTransferService : JobService() {
  ...
}

    Java

    class CustomTransferService extends JobService() {

    ....

}

  2. Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

    <manifest ...>
    <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
    <application ...>
        ...
    </application>
</manifest>

  3. Call the setUserInitiated() method when building a JobInfo object. (This method is available beginning with Android 14.) We also recommend that you offer a payload size estimate by calling setEstimatedNetworkBytes() while creating your job.

    Kotlin

    val networkRequestBuilder = NetworkRequest.Builder()
        // Add or remove capabilities based on your requirements.
        // For example, this code specifies that the job won't run
        // unless there's a connection to the internet (not just a local
        // network), and the connection doesn't charge per-byte.
        .addCapability(NET_CAPABILITY_INTERNET)
        .addCapability(NET_CAPABILITY_NOT_METERED)
        .build()

val jobInfo = JobInfo.Builder(jobId,
              ComponentName(mContext, CustomTransferService::class.java))
        // ...
        .setUserInitiated(true)
        .setRequiredNetwork(networkRequestBuilder)
        // Provide your estimate of the network traffic here
        .setEstimatedNetworkBytes(1024 * 1024 * 1024)
        // ...
        .build()

    Java

    NetworkRequest networkRequest = new NetworkRequest.Builder()
    // Add or remove capabilities based on your requirements.
    // For example, this code specifies that the job won't run
    // unless there's a connection to the internet (not just a local
    // network), and the connection doesn't charge per-byte.
    .addCapability(NET_CAPABILITY_INTERNET)
    .addCapability(NET_CAPABILITY_NOT_METERED)
    .build();

JobInfo jobInfo = JobInfo.Builder(jobId,
        new ComponentName(mContext, CustomTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024)
    // ...
    .build();

  4. While the job is being executed, call setNotification() on the JobService object. Calling setNotification() makes the user aware that the job is running, both in the Task Manager and in the status bar notification area.

    When execution is complete, call jobFinished() to signal to the system that the job is complete, or that the job should be rescheduled.

    Kotlin

    class CustomTransferService: JobService() {
    private val scope = CoroutineScope(Dispatchers.IO)

    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    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)
        // Execute the work associated with this job asynchronously.
        scope.launch {
            doDownload(params)
        }
        return true
    }

    private suspend fun doDownload(params: JobParameters) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false)
    }

    // Called when the system stops the job.
    override fun onStopJob(params: JobParameters?): Boolean {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true // or return false if job should end entirely
    }
}

    Java

    class CustomTransferService extends JobService{
    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    @Override
    public boolean onStartJob(JobParameters params) {
        Notification notification = Notification.Builder(getBaseContext(),
                                        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)
        // Execute the work associated with this job asynchronously.
        new Thread(() -> doDownload(params)).start();
        return true;
    }

    private void doDownload(JobParameters params) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false);
    }

    // Called when the system stops the job.
    @Override
    public boolean onStopJob(JobParameters params) {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true; // or return false if job should end entirely
    }
}

  5. Periodically update the notification to keep the user informed of the job's status and progress. If you cannot determine the transfer size ahead of scheduling the job, or need to update the estimated transfer size, use the new API, updateEstimatedNetworkBytes() to update the transfer size after it becomes known.

Recommendations

To run UIDT jobs effectively, do the following:

  1. Clearly define network constraints and job execution constraints to specify when the job should be executed.

  2. Execute the task asynchronously in onStartJob(); for example, you can do this by using a coroutine. If you don't run the task asynchronously, the work runs on the main thread and might block it, which can cause an ANR.

  3. To avoid running the job longer than necessary, call jobFinished() when the transfer finishes, whether it succeeds or fails. That way, the job doesn't run longer than necessary. To discover why a job was stopped, implement the onStopJob() callback method and call JobParameters.getStopReason().

Retrocompatibilidad

Actualmente, no hay ninguna biblioteca de Jetpack que admita trabajos de UIDT. Por este motivo, te recomendamos que limites el cambio con código que verifique que estás ejecutando Android 14 o una versión posterior. En versiones anteriores de Android, puedes usar la implementación del servicio en primer plano de WorkManager como un enfoque alternativo.

Este es un ejemplo de código que verifica la versión del sistema adecuada:

Kotlin

fun beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context)
    } else {
        scheduleDownloadUIDTJob(context)
    }
}

private fun scheduleDownloadUIDTJob(context: Context) {
    // build jobInfo
    val jobScheduler: JobScheduler =
        context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
    jobScheduler.schedule(jobInfo)
}

private fun scheduleDownloadFGSWorker(context: Context) {
    val myWorkRequest = OneTimeWorkRequest.from(DownloadWorker::class.java)
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

Java

public void beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context);
    } else {
        scheduleDownloadUIDTJob(context);
    }
}

private void scheduleDownloadUIDTJob(Context context) {
    // build jobInfo
    JobScheduler jobScheduler =
            (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE);
    jobScheduler.schedule(jobInfo);
}

private void scheduleDownloadFGSWorker(Context context) {
    OneTimeWorkRequest myWorkRequest = OneTimeWorkRequest.from(DownloadWorker.class);
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

Detén los trabajos de UIDT

Both the user and the system can stop user-initiated transfer jobs.

Por el usuario, desde el Administrador de tareas

The user can stop a user-initiated data transfer job that appears in the Task Manager.

At the moment that the user presses Stop, the system does the following:

  • Terminates your app's process immediately, including all other jobs or foreground services running.
  • Doesn't call onStopJob() for any running jobs.
  • Prevents user-visible jobs from being rescheduled.

For these reasons, it's recommended to provide controls in the notification posted for the job to allow gracefully stopping and rescheduling the job.

Note that, under special circumstances, the Stop button doesn't appear next to the job in the Task Manager, or the job isn't shown in the Task Manager at all.

Por el sistema

Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:

  • A developer-defined constraint is no longer met.
  • The system determines that the job has run for longer than necessary to complete the data transfer task.
  • The system needs to prioritize system health and stop jobs due to increased thermal state.
  • The app process is killed due to low device memory.

When the job is stopped by the system for reasons other than low device memory, the system calls onStopJob(), and the system retries the job at a time that the system deems to be optimal. Make sure that your app can persist the data transfer state even if onStopJob() isn't called, and that your app can restore this state when onStartJob() is called again.

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

Las apps solo pueden iniciar una tarea de transferencia de datos que inicie el usuario si estas están en la ventana visible o si se cumplen ciertas condiciones:

  • 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 para ejecutarse en un momento en el que no se cumplen las condiciones necesarias, 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 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()

Prueba

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

Consulta también

Recursos adicionales

Para obtener más información sobre las transferencias de datos iniciadas por el usuario, consulta los siguientes recursos adicionales: