WorkManager की मदद से, WorkRequest को सूची में शामिल करने के बाद भी अपडेट किया जा सकता है. आम तौर पर, यह उन बड़े ऐप्लिकेशन के लिए ज़रूरी होता है जो अक्सर पाबंदियों में बदलाव करते हैं या जिन्हें अपने वर्कर को तुरंत अपडेट करना पड़ता है. WorkManager के वर्शन 2.8.0 से, updateWork() एपीआई का इस्तेमाल करके ऐसा किया जा सकता है.
updateWork() तरीके से, WorkRequest के कुछ पहलुओं को तुरंत बदला जा सकता है. इसके लिए, आपको मैन्युअल तरीके से रद्द करने और नए को सूची में शामिल करने की प्रोसेस से नहीं गुज़रना पड़ता. इससे डेवलपमेंट की प्रोसेस काफ़ी आसान हो जाती है.
काम रद्द करने से बचें
आम तौर पर, आपको किसी मौजूदा WorkRequest को रद्द करने और नए WorkRequest को सूची में शामिल करने से बचना चाहिए. ऐसा करने से, ऐप्लिकेशन कुछ टास्क को दोहरा सकता है. साथ ही, आपको काफ़ी ज़्यादा अतिरिक्त कोड लिखना पड़ सकता है.
यहां कुछ उदाहरण दिए गए हैं, जिनसे पता चलता है कि WorkRequest को रद्द करने से कब समस्याएं आ सकती हैं:
- बैक-एंड अनुरोध: अगर सर्वर को भेजे जाने वाले पेलोड की कंप्यूटिंग के दौरान, किसी
Workerको रद्द किया जाता है, तो नएWorkerको फिर से शुरू करना होगा. साथ ही, ज़्यादा खर्च वाले पेलोड की फिर से कंप्यूटिंग करनी होगी. - शेड्यूल करना: अगर आपने किसी
PeriodicWorkRequestको रद्द कर दिया है और आपको नएPeriodicWorkRequestको उसी शेड्यूल पर लागू करना है, तो आपको टाइम ऑफ़सेट का हिसाब लगाना होगा. इससे यह पक्का किया जा सकेगा कि लागू करने का नया समय, काम के पिछले अनुरोध के हिसाब से हो.
updateWork() एपीआई की मदद से, काम के अनुरोध की पाबंदियों और अन्य पैरामीटर को अपडेट किया जा सकता है. इसके लिए, आपको नए अनुरोध को रद्द करने और सूची में शामिल करने की ज़रूरत नहीं पड़ती.
काम को कब रद्द करना चाहिए
कुछ मामलों में, आपको updateWork() को कॉल करने के बजाय, सीधे तौर पर WorkRequest को रद्द कर देना चाहिए. जब आपको सूची में शामिल किए गए काम के बुनियादी नेचर में बदलाव करना हो, तब आपको ऐसा करना चाहिए.
काम को कब अपडेट करना चाहिए
मान लें कि कोई फ़ोटो ऐप्लिकेशन, उपयोगकर्ता की फ़ोटो का रोज़ बैकअप लेता है. ऐसा करने के लिए, इसने एक PeriodicWorkRequest को सूची में शामिल किया है. WorkRequest के लिए ज़रूरी है कि डिवाइस चार्ज हो रहा हो और वाई-फ़ाई से कनेक्ट हो.
हालांकि, उपयोगकर्ता अपने डिवाइस को फ़ास्ट चार्जर से दिन में सिर्फ़ 20 मिनट के लिए चार्ज करता है. इस मामले में, ऐप्लिकेशन WorkRequest को अपडेट कर सकता है, ताकि चार्जिंग की पाबंदी को कम किया जा सके. इससे डिवाइस के पूरी तरह चार्ज न होने पर भी, फ़ोटो अपलोड की जा सकती हैं.
इस स्थिति में, वर्क रिक्वेस्ट की पाबंदियों को अपडेट करने के लिए, updateWork() तरीके का इस्तेमाल किया जा सकता है.
काम की जानकारी अपडेट करने का तरीका
updateWork() मेथड, किसी मौजूदा
WorkRequest को अपडेट करने का एक आसान तरीका उपलब्ध कराता है. इसके लिए, आपको किसी नए को रद्द करने और सूची में शामिल करने की ज़रूरत नहीं पड़ती.
सूची में शामिल किए गए काम को अपडेट करने के लिए, यह तरीका अपनाएं:
- सूची में शामिल काम के लिए मौजूदा आईडी पाना: उस WorkRequest का आईडी पाएं जिसे आपको अपडेट करना है. इस आईडी को किसी भी
getWorkInfoएपीआई की मदद से वापस पाया जा सकता है. इसके अलावा, शुरुआती WorkRequest से आईडी को मैन्युअल तरीके से सेव करके भी वापस पाया जा सकता है. इसके लिए, आईडी को सूची में शामिल करने से पहले, सार्वजनिक प्रॉपर्टीWorkRequest.idका इस्तेमाल करें. - नया WorkRequest बनाएं: नया
WorkRequestबनाएं औरWorkRequest.Builder.setID()का इस्तेमाल करके, इसका आईडी मौजूदाWorkRequestके आईडी से मैच करें. - पाबंदियां सेट करना: WorkManager की नई पाबंदियां पास करने के लिए,
WorkRequest.Builder.setConstraints()का इस्तेमाल करें. - updateWork को कॉल करें:
updateWork()को नया WorkRequest पास करें.
काम के उदाहरण अपडेट करना
यहां Kotlin में एक उदाहरण के तौर पर कोड स्निपेट दिया गया है. इसमें बताया गया है कि फ़ोटो अपलोड करने के लिए इस्तेमाल किए जाने वाले WorkRequest की बैटरी से जुड़ी पाबंदियों को बदलने के लिए, updateWork() तरीके का इस्तेमाल कैसे किया जाता है:
suspend fun updatePhotoUploadWork() {
// Get instance of WorkManager.
val workManager = WorkManager.getInstance(context)
// Retrieve the work request ID. In this example, the work being updated is unique
// work so we can retrieve the ID using the unique work name.
val photoUploadWorkInfoList = workManager.getWorkInfosForUniqueWork(
PHOTO_UPLOAD_WORK_NAME
).await()
val existingWorkRequestId = photoUploadWorkInfoList.firstOrNull()?.id ?: return
// Update the constraints of the WorkRequest to not require a charging device.
val newConstraints = Constraints.Builder()
// Add other constraints as required here.
.setRequiresCharging(false)
.build()
// Create new WorkRequest from existing Worker, new constraints, and the id of the old WorkRequest.
val updatedWorkRequest: WorkRequest =
OneTimeWorkRequestBuilder<MyWorker>()
.setConstraints(newConstraints)
.setId(existingWorkRequestId)
.build()
// Pass the new WorkRequest to updateWork().
workManager.updateWork(updatedWorkRequest)
}
नतीजे को मैनेज करना
updateWork(), ListenableFuture<UpdateResult> दिखाता है. दिए गए UpdateResult में कई वैल्यू में से कोई एक वैल्यू हो सकती है. इससे पता चलता है कि WorkManager आपके बदलावों को लागू कर पाया या नहीं. इससे यह भी पता चलता है कि बदलाव कब लागू किया गया.
ज़्यादा जानकारी के लिए, updateWork() और UpdateResult
रेफ़रंस देखें.
जनरेशन के साथ काम ट्रैक करना
हर बार WorkRequest को अपडेट करने पर, इसकी जनरेशन एक से बढ़ जाती है. इससे आपको यह ट्रैक करने में मदद मिलती है कि फ़िलहाल कौनसा WorkRequest सूची में है.
जनरेशन की मदद से, आपको काम के अनुरोधों को देखने, ट्रेस करने, और टेस्ट करने पर ज़्यादा कंट्रोल मिलता है.
WorkRequest जनरेट करने के लिए, यह तरीका अपनाएं:
- WorkInfo: अपने
WorkRequestसे जुड़ेWorkInfoका इंस्टेंस पाने के लिए,WorkManager.getWorkInfoById()को कॉल करें.WorkInfoदिखाने वाले कई तरीकों में से किसी एक को कॉल किया जा सकता है. ज़्यादा जानकारी के लिए, WorkManager रेफ़रंस देखें.
- getGeneration:
WorkInfoके इंस्टेंस परgetGeneration()को कॉल करें. दिखाया गयाInt,WorkRequestके जनरेशन से मेल खाता है.- ध्यान दें कि इसमें जनरेशन फ़ील्ड या प्रॉपर्टी नहीं होती है. इसमें सिर्फ़
WorkInfo.getGeneration()मेथड होता है.
- ध्यान दें कि इसमें जनरेशन फ़ील्ड या प्रॉपर्टी नहीं होती है. इसमें सिर्फ़
ट्रैक जनरेट करने का उदाहरण
WorkRequest के जनरेशन को वापस पाने के लिए, ऊपर बताए गए वर्कफ़्लो को लागू करने का एक उदाहरण यहां दिया गया है.
// Get instance of WorkManager.
val workManager = WorkManager.getInstance(context)
// Retrieve WorkInfo instance.
val workInfo = workManager.getWorkInfoById(oldWorkRequestId)
// Call getGeneration to retrieve the generation.
val generation = workInfo.getGeneration()
काम को अपडेट करने से जुड़ी नीतियां
पहले, समय-समय पर होने वाले काम को अपडेट करने के लिए, ExistingPeriodicWorkPolicy.REPLACE नीति के साथ PeriodicWorkRequest को सूची में शामिल करने का सुझाव दिया जाता था.
अगर उसी यूनीक id के साथ कोई PeriodicWorkRequest बाकी है, तो काम का नया अनुरोध उसे रद्द कर देगा और मिटा देगा. इस नीति के इस्तेमाल पर अब रोक लगा दी गई है. इसके बजाय, ExistingPeriodicWorkPolicy.UPDATE का इस्तेमाल करके वर्कफ़्लो को मैनेज करें.
उदाहरण के लिए, PeriodicWorkRequest के साथ enqueueUniquePeriodicWork का इस्तेमाल करते समय, ExistingPeriodicWorkPolicy.UPDATE नीति के साथ नए PeriodicWorkRequest को शुरू किया जा सकता है. अगर एक ही यूनीक नाम वाला कोई PeriodicWorkRequest बाकी है, तो WorkManager उसे नई जानकारी के साथ अपडेट कर देता है. इस वर्कफ़्लो का इस्तेमाल करने के बाद, updateWork() का इस्तेमाल करना ज़रूरी नहीं है.