দীর্ঘ সময় ধরে চলা ওয়ার্কারের জন্য সহায়তা

WorkManager-এ দীর্ঘ সময় ধরে চলা ওয়ার্কারের জন্য বিল্ট-ইন সহায়তা আছে। এই ধরনের ক্ষেত্রে, WorkManager, OS-কে একটি সিগন্যাল দিতে পারে যে এই কাজ চলাকালীন সম্ভব হলে প্রসেসটি চালু রাখা উচিত। এইসব Worker ১০ মিনিটের বেশি সময় ধরে চলতে পারে। এই নতুন ফিচারের ব্যবহারের উদাহরণ হিসেবে বাল্ক আপলোড বা ডাউনলোড (যা খণ্ড খণ্ড করা যায় না), স্থানীয়ভাবে ML মডেলের ক্রাঞ্চিং বা এমন কোনও টাস্ক যা অ্যাপের ব্যবহারকারীর কাছে গুরুত্বপূর্ণ।

WorkManager আপনার হয়ে WorkRequest কার্যকর করার জন্য ফোরগ্রাউন্ড সার্ভিস ম্যানেজ ও রান করে, একই সাথে কনফিগার করা যায় এমন বিজ্ঞপ্তিও দেখায়।

ListenableWorker-এ এখন setForegroundAsync() API কাজ করে এবং CoroutineWorker-এ সাসপেন্ড করা setForeground() API কাজ করে। এইসব API ডেভেলপারদের এই WorkRequest গুরুত্বপূর্ণ (ব্যবহারকারীর দৃষ্টিভঙ্গি থেকে) বা দীর্ঘ-মেয়াদী হিসেবে নির্দিষ্ট করার অনুমতি দেয়।

2.3.0-alpha03 থেকে শুরু করে, WorkManager আপনাকে একটি PendingIntent তৈরি করার অনুমতি দেয়, যা createCancelPendingIntent() API ব্যবহার করে একটি নতুন Android কম্পোনেন্ট রেজিস্টার না করেই ওয়ার্কারদের বাতিল করতে ব্যবহার করা যেতে পারে। এই পদ্ধতিটি বিশেষ করে setForegroundAsync() বা setForeground() API-এর সাথে ব্যবহার করলে উপযোগী হয়, যা 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"
   }
}

জাভা

ListenableWorker বা Worker ব্যবহারকারী ডেভেলপাররা setForegroundAsync() API কল করতে পারেন, যা ListenableFuture<Void> রিটার্ন করে। এছাড়াও, আপনি setForegroundAsync()-এ কল করে বর্তমানে চলা Notification আপডেট করতে পারবেন।

এখানে একটি ফাইল ডাউনলোড করে এমন একটি দীর্ঘ সময় ধরে চলা ওয়ার্কারের একটি সহজ উদাহরণ দেওয়া হল। এই Worker, ডাউনলোড প্রগ্রেস দেখায় এমন একটি চলমান 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 (API লেভেল 34) বা তার পরবর্তী যেকোনও ভার্সনকে টার্গেট করলে, আপনাকে অবশ্যই দীর্ঘ সময় ধরে চলা সব ওয়ার্কারের জন্য ফোরগ্রাউন্ড পরিষেবার ধরন উল্লেখ করতে হবে। আপনার অ্যাপ Android 10 (API লেভেল 29) বা তার পরবর্তী কোনও ভার্সনকে টার্গেট করলে এবং এতে দীর্ঘ সময় ধরে চলা কোনও ওয়ার্কার থাকলে, যার লোকেশন অ্যাক্সেস করার প্রয়োজন হয়, তাহলে উল্লেখ করুন যে ওয়ার্কারটি location-এর ফোরগ্রাউন্ড সার্ভিস টাইপ ব্যবহার করে।

আপনার অ্যাপ Android 11 (API লেভেল 30) বা তার পরবর্তী কোনও ভার্সনকে টার্গেট করলে এবং এতে দীর্ঘ সময় ধরে চলা কোনও ওয়ার্কার থাকলে যার ক্যামেরা বা মাইক্রোফোন অ্যাক্সেস করার প্রয়োজন হয়, তাহলে যথাক্রমে camera বা microphone ফোরগ্রাউন্ড সার্ভিসের ধরন ঘোষণা করুন।

এইসব ফোরগ্রাউন্ড সার্ভিসের ধরন যোগ করতে, নিম্নলিখিত বিভাগে বর্ণনা করা ধাপগুলি সম্পূর্ণ করুন।

অ্যাপ ম্যানিফেস্টে ফোরগ্রাউন্ড পরিষেবার ধরন ঘোষণা করা

আপনার অ্যাপের ম্যানিফেস্টে ওয়ার্কারের ফোরগ্রাউন্ড পরিষেবার ধরন ঘোষণা করুন। নিম্নলিখিত উদাহরণে, কর্মীর লোকেশন ও মাইক্রোফোনে অ্যাক্সেস প্রয়োজন:

AndroidManifest.xml

<service
   android:name="androidx.work.impl.foreground.SystemForegroundService"
   android:foregroundServiceType="location|microphone"
   tools:node="merge" />

রানটাইমে ফোরগ্রাউন্ড পরিষেবার ধরন নির্দিষ্ট করুন

setForeground() বা setForegroundAsync() কল করার সময়, আপনি ফোরগ্রাউন্ড পরিষেবার ধরন নির্দিষ্ট করেছেন কিনা তা নিশ্চিত করুন।

MyLocationAndMicrophoneWorker

Kotlin

private fun createForegroundInfo(progress: String): ForegroundInfo {
   // ...
   return ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION or
FOREGROUND_SERVICE_TYPE_MICROPHONE) }

জাভা

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