उपयोगकर्ता की ओर से डेटा ट्रांसफ़र करना

If you need to perform a data transfer that may take a long time, you can create a JobScheduler job and identify it as a user-initiated data transfer (UIDT) job. UIDT jobs are intended for longer-duration data transfers that are initiated by the device user, such as downloading a file from a remote server. UIDT jobs were introduced with Android 14 (API level 34).

User-initiated data transfer jobs are started by the user. These jobs require a notification, start immediately, and may be able to run for an extended period of time as system conditions allow. You can run several user-initiated data transfer jobs concurrently.

User initiated jobs must be scheduled while the application is visible to the user (or in one of the allowed conditions). After all constraints are met, user initiated jobs can be executed by the OS, subject to system health restrictions. The system may also use the provided estimated payload size to determine how long the job executes.

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क शेड्यूल करना

उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र के टास्क को चलाने के लिए, यह तरीका अपनाएं:

1. पक्का करें कि आपके ऐप्लिकेशन ने मेनिफ़ेस्ट में JobService और उससे जुड़ी अनुमतियों का एलान किया हो:

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

   साथ ही, डेटा ट्रांसफ़र के लिए JobService की कोई खास सबक्लास तय करें:

   Kotlin

   class CustomTransferService : JobService() {
     ...
   }

   Java

   class CustomTransferService extends JobService() {
   
       ....
   
   }

2. मेनिफ़ेस्ट में RUN_USER_INITIATED_JOBS अनुमति के बारे में बताएं:

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

3. JobInfo ऑब्जेक्ट बनाते समय, setUserInitiated() तरीके को कॉल करें. (यह तरीका, Android 14 और उसके बाद के वर्शन में उपलब्ध है.) हमारा यह भी सुझाव है कि नौकरी बनाते समय, setEstimatedNetworkBytes() को कॉल करके, पेलोड के साइज़ का अनुमान दें.

   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. जब काम पूरा हो रहा हो, तब JobService ऑब्जेक्ट पर call setNotification() करें. Calling setNotification() से उपयोगकर्ता को यह पता चलता है कि टास्क चल रहा है. यह जानकारी, टास्क मैनेजर और स्टेटस बार की सूचना वाली जगह, दोनों में दिखती है.

   जब प्रोसेस पूरी हो जाए, तब jobFinished() को कॉल करके सिस्टम को बताएं कि काम पूरा हो गया है या काम को फिर से शेड्यूल किया जाना चाहिए.

   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. सूचना को समय-समय पर अपडेट करें, ताकि उपयोगकर्ता को नौकरी की स्थिति और उसकी प्रोग्रेस के बारे में जानकारी मिलती रहे. अगर आपको जॉब शेड्यूल करने से पहले, ट्रांसफ़र किए जाने वाले डेटा के साइज़ का पता नहीं चल पा रहा है या आपको ट्रांसफ़र किए जाने वाले डेटा के अनुमानित साइज़ को अपडेट करना है, तो नए एपीआई updateEstimatedNetworkBytes() का इस्तेमाल करें. इससे, ट्रांसफ़र किए जाने वाले डेटा के साइज़ का पता चलने के बाद, उसे अपडेट किया जा सकेगा.

सुझाव

यूआईडीटी जॉब को असरदार तरीके से चलाने के लिए, यह तरीका अपनाएं:

1. नेटवर्क और जॉब के एक्ज़ीक्यूशन से जुड़ी पाबंदियों के बारे में साफ़ तौर पर बताएं, ताकि यह तय किया जा सके कि जॉब को कब एक्ज़ीक्यूट किया जाना चाहिए.

2. onStartJob() में टास्क को एसिंक्रोनस तरीके से एक्ज़ीक्यूट करें. उदाहरण के लिए, कोरूटीन का इस्तेमाल करके ऐसा किया जा सकता है. अगर टास्क को एसिंक्रोनस तरीके से नहीं चलाया जाता है, तो काम मुख्य थ्रेड पर चलता है और उसे ब्लॉक कर सकता है. इससे एएनआर की गड़बड़ी हो सकती है.

3. ज़रूरत से ज़्यादा समय तक नौकरी न चलाने के लिए, ट्रांसफ़र पूरा होने पर jobFinished() को कॉल करें. भले ही, ट्रांसफ़र पूरा हुआ हो या नहीं. इससे, नौकरी को ज़रूरत से ज़्यादा समय तक नहीं चलाया जाता है. यह जानने के लिए कि कोई जॉब क्यों रोकी गई, onStopJob() कॉलबैक तरीके को लागू करें और JobParameters.getStopReason() को कॉल करें.

पिछले वर्शन के गेम खेलने की सुविधा

There is currently no Jetpack library that supports UIDT jobs. For this reason, we recommend that you gate your change with code that verifies that you're running on Android 14 or higher. On lower Android versions, you can use WorkManager's foreground service implementation as a fallback approach.

Here's an example of code that checks for the appropriate system version:

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)
}

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)
}

UIDT जॉब बंद करना

उपयोगकर्ता और सिस्टम, दोनों ही उपयोगकर्ता की ओर से शुरू किए गए ट्रांसफ़र के कामों को रोक सकते हैं.

उपयोगकर्ता ने टास्क मैनेजर से

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.

सिस्टम के हिसाब से

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.

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क को शेड्यूल करने की अनुमति देने वाली शर्तें

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

• If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
• If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

User-Initiated Data Transfer Jobs के लिए अनुमति वाली पाबंदियां

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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

टेस्ट करना

The following list shows some steps on how to test your app's jobs manually:

• To get the job ID, get the value that is defined upon the job being built.

• To run a job immediately, or to retry a stopped job, run the following command in a terminal window:

  adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

• To simulate the system force-stopping a job (due to system health or out-of-quota conditions), run the following command in a terminal window:

  adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

यह भी देखें:

• बैकग्राउंड में होने वाले टास्क के बारे में खास जानकारी
• डेटा ट्रांसफ़र के बैकग्राउंड टास्क के विकल्प

अन्य संसाधन

उपयोगकर्ता के अनुरोध पर होने वाले डेटा ट्रांसफ़र के बारे में ज़्यादा जानने के लिए, यहां दिए गए अतिरिक्त संसाधन देखें:

• यूआईडीटी इंटिग्रेशन पर केस स्टडी: Google Maps ने उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र एपीआई का इस्तेमाल करके, डाउनलोड की विश्वसनीयता को 10% तक बेहतर बनाया