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.
उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क शेड्यूल करना
उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र के टास्क को चलाने के लिए, यह तरीका अपनाएं:
पक्का करें कि आपके ऐप्लिकेशन ने मेनिफ़ेस्ट में
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() { .... }
मेनिफ़ेस्ट में
RUN_USER_INITIATED_JOBSअनुमति के बारे में बताएं:<manifest ...> <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" /> <application ...> ... </application> </manifest>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, 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, 1024 * 1024 * 1024) // ... .build();
टास्क पूरा होने के दौरान,
JobServiceऑब्जेक्ट परsetNotification()को कॉल करें.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 } }
सूचना को समय-समय पर अपडेट करें, ताकि उपयोगकर्ता को नौकरी की स्थिति और उसकी प्रोग्रेस के बारे में जानकारी मिलती रहे. अगर आपको जॉब शेड्यूल करने से पहले, ट्रांसफ़र किए जाने वाले डेटा के साइज़ का पता नहीं चल पा रहा है या आपको ट्रांसफ़र किए जाने वाले डेटा के अनुमानित साइज़ को अपडेट करना है, तो नए एपीआई
updateEstimatedNetworkBytes()का इस्तेमाल करें. इससे, ट्रांसफ़र किए जाने वाले डेटा के साइज़ का पता चलने के बाद, उसे अपडेट किया जा सकेगा.
सुझाव
UIDT जॉब को असरदार तरीके से चलाने के लिए, यह तरीका अपनाएं:
नेटवर्क और जॉब को पूरा करने से जुड़ी पाबंदियों के बारे में साफ़ तौर पर बताएं, ताकि यह तय किया जा सके कि जॉब को कब पूरा किया जाना चाहिए.
टास्क को
onStartJob()में एसिंक्रोनस तरीके से एक्ज़ीक्यूट करें. उदाहरण के लिए, कोरूटीन का इस्तेमाल करके ऐसा किया जा सकता है. अगर टास्क को एसिंक्रोनस तरीके से नहीं चलाया जाता है, तो काम मुख्य थ्रेड पर चलता है और इसे ब्लॉक कर सकता है. इससे ANR की गड़बड़ी हो सकती है.टास्क को ज़रूरत से ज़्यादा समय तक चलने से रोकने के लिए, ट्रांसफ़र पूरा होने पर
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:
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) }
UIDT जॉब बंद करना
उपयोगकर्ता और सिस्टम, दोनों ही उपयोगकर्ता की ओर से शुरू किए गए ट्रांसफ़र के कामों को रोक सकते हैं.
उपयोगकर्ता ने टास्क मैनेजर से
उपयोगकर्ता, टास्क मैनेजर में दिखने वाले, उपयोगकर्ता के शुरू किए गए डेटा ट्रांसफ़र जॉब को रोक सकता है.
जब उपयोगकर्ता रोकें बटन दबाता है, तो सिस्टम ये काम करता है:
- आपके ऐप्लिकेशन की प्रोसेस को तुरंत बंद कर देता है. इसमें, चल रही सभी अन्य जॉब या फ़ोरग्राउंड सेवाएं भी शामिल हैं.
- किसी भी चल रही जॉब के लिए
onStopJob()को कॉल नहीं करता. - उपयोगकर्ता को दिखने वाले जॉब को फिर से शेड्यूल होने से रोकता है.
इन वजहों से, हमारा सुझाव है कि जॉब के लिए पोस्ट की गई सूचना में कंट्रोल दें, ताकि जॉब को आसानी से रोका और फिर से शेड्यूल किया जा सके.
ध्यान दें कि कुछ खास मामलों में, टास्क मैनेजर में टास्क के बगल में बंद करें बटन नहीं दिखता. इसके अलावा, ऐसा भी हो सकता है कि टास्क मैनेजर में टास्क न दिखे.
सिस्टम के हिसाब से
सामान्य टास्क के उलट, उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र के टास्क पर ऐप्लिकेशन के स्टैंडबाय बकेट के कोटे का कोई असर नहीं पड़ता. हालांकि, अगर इनमें से कोई भी शर्त पूरी होती है, तो सिस्टम अब भी काम रोक देता है:
- डेवलपर की तय की गई कोई शर्त पूरी नहीं हो रही है.
- सिस्टम यह तय करता है कि डेटा ट्रांसफ़र करने के टास्क को पूरा करने के लिए, नौकरी को ज़रूरत से ज़्यादा समय तक चलाया गया है.
- सिस्टम को सिस्टम की सेहत को प्राथमिकता देनी चाहिए और ज़्यादा तापमान की वजह से काम बंद कर देना चाहिए.
- डिवाइस की मेमोरी कम होने की वजह से, ऐप्लिकेशन की प्रोसेस बंद हो गई है.
जब डिवाइस की मेमोरी कम होने के अलावा किसी अन्य वजह से सिस्टम जॉब को रोक देता है, तो सिस्टम onStopJob() को कॉल करता है. इसके बाद, सिस्टम उस समय जॉब को फिर से शुरू करने की कोशिश करता है जब सिस्टम को लगता है कि यह सबसे सही समय है. पक्का करें कि onStopJob() को कॉल न किए जाने पर भी, आपका ऐप्लिकेशन डेटा ट्रांसफ़र की स्थिति को बनाए रख सकता हो. साथ ही, onStartJob() को फिर से कॉल किए जाने पर, आपका ऐप्लिकेशन इस स्थिति को वापस ला सकता हो.
उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क को शेड्यूल करने की अनुमति देने वाली शर्तें
ऐप्लिकेशन, उपयोगकर्ता से शुरू किए गए डेटा ट्रांसफ़र को सिर्फ़ तब शुरू कर सकते हैं, जब ऐप्लिकेशन दिखने वाली विंडो में हो या कुछ शर्तें पूरी हों:
- अगर कोई ऐप्लिकेशन बैकग्राउंड से गतिविधियां शुरू कर सकता है, तो वह बैकग्राउंड से उपयोगकर्ता के शुरू किए गए डेटा ट्रांसफ़र जॉब भी शुरू कर सकता है.
- अगर किसी ऐप्लिकेशन की गतिविधि, हाल ही में इस्तेमाल किए गए ऐप्लिकेशन की स्क्रीन पर मौजूद किसी मौजूदा टास्क के बैक स्टैक में है, तो इसका मतलब यह नहीं है कि उपयोगकर्ता की ओर से शुरू की गई डेटा ट्रांसफ़र की प्रोसेस शुरू की जा सकती है.
अगर जॉब को ऐसे समय पर चलाने के लिए शेड्यूल किया गया है जब ज़रूरी शर्तें पूरी नहीं होती हैं, तो जॉब पूरा नहीं होता और RESULT_FAILURE गड़बड़ी कोड दिखाता है.
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()
टेस्ट करना
नीचे दी गई सूची में, आपके ऐप्लिकेशन के जॉब को मैन्युअल तौर पर टेस्ट करने के कुछ तरीके बताए गए हैं:
- जॉब आईडी पाने के लिए, बनाए जा रहे काम पर तय की गई वैल्यू पाएं.
किसी जॉब को तुरंत चलाने के लिए या रोके गए जॉब को फिर से चलाने के लिए, इन्हें चलाएं कमांड:
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
किसी काम को ज़बरदस्ती रोकने के लिए (सिस्टम की हेल्थ या कोटे से बाहर की शर्तें), टर्मिनल विंडो में नीचे दी गई कमांड चलाएं:
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
यह भी देखें:
अन्य संसाधन
उपयोगकर्ता के अनुरोध पर होने वाले डेटा ट्रांसफ़र के बारे में ज़्यादा जानने के लिए, यहां दिए गए अतिरिक्त संसाधन देखें:
- यूआईडीटी इंटिग्रेशन पर केस स्टडी: Google Maps ने उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र एपीआई का इस्तेमाल करके, डाउनलोड की विश्वसनीयता को 10% तक बेहतर बनाया