WorkManager में लंबे समय से काम करने वाले कर्मचारियों के लिए, सहायता पहले से मौजूद है. ऐसे मामलों में, WorkManager, ओएस को यह सिग्नल दे सकता है कि इस प्रोसेस को चालू रखा जाना चाहिए अगर संभव हो. ये वर्कर 10 से ज़्यादा समय तक काम कर सकते हैं मिनट. इस नई सुविधा के इस्तेमाल के उदाहरणों में, एक साथ कई फ़ाइलें अपलोड करना या डाउनलोड (जिन्हें अलग-अलग हिस्सों में नहीं बांटा जा सकता), स्थानीय तौर पर किसी एमएल मॉडल पर क्रंच करना या कोई टास्क जो ऐप्लिकेशन के उपयोगकर्ता के लिए ज़रूरी हो.
WorkManager आपकी ओर से फ़ोरग्राउंड सेवा को मैनेज करता है और उसे चलाता है
WorkRequest
को एक्ज़ीक्यूट करने के साथ-साथ, कॉन्फ़िगर किया जा सकने वाला
सूचना पर टैप करें.
ListenableWorker
अब setForegroundAsync()
API के साथ काम करता है और
CoroutineWorker
निलंबित setForeground()
एपीआई को निलंबित करता है. ये
API, डेवलपर को यह बताने की अनुमति देता है कि यह WorkRequest
अहम है (किसी
उपयोगकर्ता के अनुभव) या लंबे समय तक विज्ञापन देखना शामिल है.
2.3.0-alpha03
की शुरुआत में, WorkManager आपको
PendingIntent
, जिसका इस्तेमाल करके, कर्मचारियों को रद्द करने की ज़रूरत नहीं पड़ती
createCancelPendingIntent()
का उपयोग करके एक नया Android घटक पंजीकृत करें
एपीआई. यह तरीका खास तौर पर तब मददगार होता है, जब इसे
setForegroundAsync()
या setForeground()
एपीआई, जिनका इस्तेमाल किसी फ़ाइल को जोड़ने के लिए किया जा सकता है
Worker
को रद्द करने के लिए सूचना पर की गई कार्रवाई.
लंबे समय तक काम करने वाले कर्मचारियों को बनाना और मैनेज करना
कोडिंग करने की जानकारी के हिसाब से, आपको अलग तरीका अपनाना होगा Kotlin या Java.
Kotlin
Kotlin डेवलपर को CoroutineWorker
का इस्तेमाल करना चाहिए. का उपयोग करने के बजाय
setForegroundAsync()
, आपके पास इस तरीके के निलंबित वर्शन का इस्तेमाल करने का विकल्प है.
setForeground()
.
class DownloadWorker(context: Context, parameters: WorkerParameters) :
CoroutineWorker(context, parameters) {
private val notificationManager =
context.getSystemService(Context.NOTIFICATION_SERVICE) as
NotificationManager
override suspend fun doWork(): Result {
val inputUrl = inputData.getString(KEY_INPUT_URL)
?: return Result.failure()
val outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME)
?: return Result.failure()
// Mark the Worker as important
val progress = "Starting Download"
setForeground(createForegroundInfo(progress))
download(inputUrl, outputFile)
return Result.success()
}
private fun download(inputUrl: String, outputFile: String) {
// Downloads a file and updates bytes read
// Calls setForeground() periodically when it needs to update
// the ongoing Notification
}
// Creates an instance of ForegroundInfo which can be used to update the
// ongoing notification.
private fun createForegroundInfo(progress: String): ForegroundInfo {
val id = applicationContext.getString(R.string.notification_channel_id)
val title = applicationContext.getString(R.string.notification_title)
val cancel = applicationContext.getString(R.string.cancel_download)
// This PendingIntent can be used to cancel the worker
val intent = WorkManager.getInstance(applicationContext)
.createCancelPendingIntent(getId())
// Create a Notification channel if necessary
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
createChannel()
}
val notification = NotificationCompat.Builder(applicationContext, id)
.setContentTitle(title)
.setTicker(title)
.setContentText(progress)
.setSmallIcon(R.drawable.ic_work_notification)
.setOngoing(true)
// Add the cancel action to the notification which can
// be used to cancel the worker
.addAction(android.R.drawable.ic_delete, cancel, intent)
.build()
return ForegroundInfo(notificationId, notification)
}
@RequiresApi(Build.VERSION_CODES.O)
private fun createChannel() {
// Create a Notification channel
}
companion object {
const val KEY_INPUT_URL = "KEY_INPUT_URL"
const val KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME"
}
}
Java
ListenableWorker
या Worker
का इस्तेमाल करने वाले डेवलपर
setForegroundAsync()
एपीआई, जो ListenableFuture<Void>
दिखाता है. आपने लोगों तक पहुंचाया मुफ़्त में
Notification
को अपडेट करने के लिए, setForegroundAsync()
को कॉल भी कर सकते हैं.
यहां लंबे समय तक काम करने वाले किसी ऐसे वर्कर का उदाहरण दिया गया है जो फ़ाइल डाउनलोड करता है. यह
वर्कर, चल रहे Notification
को अपडेट करने की प्रोग्रेस को ट्रैक करता रहता है, जो
डाउनलोड कर सकते हैं.
public class DownloadWorker extends Worker {
private static final String KEY_INPUT_URL = "KEY_INPUT_URL";
private static final String KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME";
private NotificationManager notificationManager;
public DownloadWorker(
@NonNull Context context,
@NonNull WorkerParameters parameters) {
super(context, parameters);
notificationManager = (NotificationManager)
context.getSystemService(NOTIFICATION_SERVICE);
}
@NonNull
@Override
public Result doWork() {
Data inputData = getInputData();
String inputUrl = inputData.getString(KEY_INPUT_URL);
String outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME);
// Mark the Worker as important
String progress = "Starting Download";
setForegroundAsync(createForegroundInfo(progress));
download(inputUrl, outputFile);
return Result.success();
}
private void download(String inputUrl, String outputFile) {
// Downloads a file and updates bytes read
// Calls setForegroundAsync(createForegroundInfo(myProgress))
// periodically when it needs to update the ongoing Notification.
}
@NonNull
private ForegroundInfo createForegroundInfo(@NonNull String progress) {
// Build a notification using bytesRead and contentLength
Context context = getApplicationContext();
String id = context.getString(R.string.notification_channel_id);
String title = context.getString(R.string.notification_title);
String cancel = context.getString(R.string.cancel_download);
// This PendingIntent can be used to cancel the worker
PendingIntent intent = WorkManager.getInstance(context)
.createCancelPendingIntent(getId());
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
createChannel();
}
Notification notification = new NotificationCompat.Builder(context, id)
.setContentTitle(title)
.setTicker(title)
.setSmallIcon(R.drawable.ic_work_notification)
.setOngoing(true)
// Add the cancel action to the notification which can
// be used to cancel the worker
.addAction(android.R.drawable.ic_delete, cancel, intent)
.build();
return new ForegroundInfo(notificationId, notification);
}
@RequiresApi(Build.VERSION_CODES.O)
private void createChannel() {
// Create a Notification channel
}
}
लंबे समय से चल रहे कर्मचारी के लिए, फ़ोरग्राउंड सेवा का टाइप जोड़ें
अगर आपका ऐप्लिकेशन, Android 14 (एपीआई लेवल 34) या उसके बाद के वर्शन को टारगेट करता है, तो आपको
फ़ोरग्राउंड सेवा का टाइप भी शामिल करें.
अगर आपका ऐप्लिकेशन, Android 10 (एपीआई लेवल 29) या उसके बाद के वर्शन को टारगेट करता है और उसमें
लंबे समय से काम करने वाला कर्मचारी जिसे जगह की जानकारी के ऐक्सेस की ज़रूरत है
location
के फ़ोरग्राउंड सेवा टाइप का इस्तेमाल करता है.
अगर आपका ऐप्लिकेशन, Android 11 (एपीआई लेवल 30) या उसके बाद वाले वर्शन को टारगेट करता है
साथ ही, इसमें एक लंबे समय तक काम करने वाला कर्मचारी मौजूद है, जिसे कैमरे या माइक्रोफ़ोन के ऐक्सेस की ज़रूरत होती है.
camera
या microphone
फ़ोरग्राउंड का एलान करें
सेवा के प्रकार शामिल हैं.
इन फ़ोरग्राउंड सेवाओं के टाइप को जोड़ने के लिए, सेक्शन पढ़ें.
ऐप्लिकेशन मेनिफ़ेस्ट में फ़ोरग्राउंड सेवा के टाइप बताएं
अपने ऐप्लिकेशन के मेनिफ़ेस्ट में, वर्कर के फ़ोरग्राउंड सेवा के टाइप की जानकारी दें. इस निम्न उदाहरण में, वर्कर को स्थान और माइक्रोफ़ोन के ऐक्सेस की आवश्यकता है:
AndroidManifest.xml
<service android:name="androidx.work.impl.foreground.SystemForegroundService" android:foregroundServiceType="location|microphone" tools:node="merge" />
रनटाइम के दौरान, फ़ोरग्राउंड सेवा के टाइप तय करें
setForeground()
या setForegroundAsync()
को कॉल करते समय पक्का करें कि
फ़ोरग्राउंड सेवा का टाइप.
MyLocationAndमाइक्रोफ़ोनवर्क
Kotlin
private fun createForegroundInfo(progress: String): ForegroundInfo { // ... return ForegroundInfo(NOTIFICATION_ID, notification, FOREGROUND_SERVICE_TYPE_LOCATION or FOREGROUND_SERVICE_TYPE_MICROPHONE) }
Java
@NonNull private ForegroundInfo createForegroundInfo(@NonNull String progress) { // Build a notification... Notification notification = ...; return new ForegroundInfo(NOTIFICATION_ID, notification, FOREGROUND_SERVICE_TYPE_LOCATION | FOREGROUND_SERVICE_TYPE_MICROPHONE); }