इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

अगर आपको ऐसा डेटा ट्रांसफ़र करना है जिसमें काफ़ी समय लग सकता है, तो JobScheduler जॉब बनाएं और उसे उपयोगकर्ता की ओर से शुरू किया गया डेटा ट्रांसफ़र (UIDT) जॉब के तौर पर पहचानें. यूआईडीटी टास्क, लंबे समय तक चलने वाले ऐसे डेटा ट्रांसफ़र के लिए होते हैं जिन्हें डिवाइस के उपयोगकर्ता ने शुरू किया है. जैसे, किसी रिमोट सर्वर से फ़ाइल डाउनलोड करना. यूआईडीटी जॉब, Android 14 (एपीआई लेवल 34) के साथ लॉन्च किए गए थे.

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क, उपयोगकर्ता ही शुरू करता है. इन जॉब के लिए सूचना की ज़रूरत होती है. ये तुरंत शुरू हो जाते हैं और सिस्टम की स्थिति के हिसाब से, लंबे समय तक चल सकते हैं. उपयोगकर्ता की ओर से शुरू की गई डेटा ट्रांसफ़र की कई प्रोसेस एक साथ चलाई जा सकती हैं.

उपयोगकर्ता की ओर से शुरू की गई जॉब, तब शेड्यूल की जानी चाहिए, जब ऐप्लिकेशन उपयोगकर्ता को दिख रहा हो (या अनुमति वाली किसी स्थिति में). सभी शर्तें पूरी होने के बाद, उपयोगकर्ता की ओर से शुरू की गई प्रोसेस को ओएस से चलाया जा सकता है. हालांकि, ऐसा सिस्टम की परफ़ॉर्मेंस से जुड़ी पाबंदियों के हिसाब से किया जाता है. सिस्टम, दिए गए अनुमानित पेलोड साइज़ का इस्तेमाल करके यह भी तय कर सकता है कि जॉब को पूरा होने में कितना समय लगेगा.

ध्यान दें: अगर फ़िलहाल, नेटवर्क डेटा ट्रांसफ़र के ऐसे इस्तेमाल के उदाहरणों के लिए WorkManager का इस्तेमाल किया जा रहा है जो कम समय के लिए और बीच में रुकने वाले होते हैं, तो हमारा सुझाव है कि आप डेटा ट्रांसफ़र करने की वह प्रक्रिया अपनाएं जो उपयोगकर्ता ने शुरू की है. इसके बजाय, WorkManager का इस्तेमाल जारी रखें. आपको यूआईडीटी का इस्तेमाल करना चाहिए या नहीं, यह बेहतर तरीके से समझने के लिए, डेटा ट्रांसफ़र के बैकग्राउंड टास्क के विकल्प दस्तावेज़ देखें.

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

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

पक्का करें कि आपके ऐप्लिकेशन के मेनिफ़ेस्ट में, 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)
        // ...
        .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, DownloadTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024)
    // ...
    .build();

जॉब के चलने के दौरान, JobService ऑब्जेक्ट पर setNotification() को कॉल करें. setNotification() को कॉल करने पर, उपयोगकर्ता को यह पता चलता है कि टास्क मैनेजर और स्टेटस बार की सूचना वाली जगह, दोनों में जॉब चल रहा है.

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

Kotlin

class DownloadTransferService: 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 DownloadTransferService 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() का इस्तेमाल करें.

सुझाव

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

नेटवर्क से जुड़ी पाबंदियों और जॉब को लागू करने से जुड़ी पाबंदियों के बारे में साफ़ तौर पर बताएं, ताकि यह तय किया जा सके कि जॉब कब लागू किया जाना चाहिए.
onStartJob() में टास्क को एसिंक्रोनस तरीके से चलाएं. उदाहरण के लिए, कोरूटीन का इस्तेमाल करके ऐसा किया जा सकता है. अगर टास्क को असिंक्रोनस तरीके से नहीं चलाया जाता है, तो काम मुख्य थ्रेड पर चलता है और उसे ब्लॉक कर सकता है. इससे ANR की गड़बड़ी हो सकती है.
ज़रूरत से ज़्यादा समय तक जॉब चलाने से बचने के लिए, ट्रांसफ़र पूरा होने पर jobFinished() को कॉल करें. भले ही, ट्रांसफ़र पूरा हो जाए या न हो. इससे, जॉब ज़रूरत से ज़्यादा समय तक नहीं चलता. किसी जॉब के रुकने की वजह जानने के लिए, onStopJob() कॉलबैक वाला तरीका लागू करें और JobParameters.getStopReason() को कॉल करें.

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

फ़िलहाल, ऐसी कोई Jetpack लाइब्रेरी नहीं है जो UIDT जॉब के साथ काम करती हो. इसलिए, हमारा सुझाव है कि आप अपने बदलाव को कोड के साथ गेट करें. इससे यह पुष्टि की जा सकेगी कि आपका ऐप्लिकेशन Android 14 या इसके बाद के वर्शन पर काम कर रहा है. Android के पुराने वर्शन पर, WorkManager की फ़ोरग्राउंड सेवा लागू करने का इस्तेमाल, फ़ॉलबैक के तौर पर किया जा सकता है.

यहां सिस्टम के सही वर्शन की जांच करने वाले कोड का उदाहरण दिया गया है:

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 के लिए अनुमति वाली पाबंदियां

Android, हर तरह के जॉब के लिए पाबंदियां असाइन करने की सुविधा देता है, ताकि जॉब सही समय पर चल सकें. ये पाबंदियां, Android 13 से उपलब्ध हैं.

ध्यान दें: यहां दी गई टेबल में, सिर्फ़ उन सीमाओं की तुलना की गई है जो हर तरह के जॉब के लिए अलग-अलग होती हैं. सभी पाबंदियों के बारे में जानने के लिए, JobScheduler डेवलपर पेज या काम से जुड़ी पाबंदियां देखें.

नीचे दी गई टेबल में, अलग-अलग तरह की जॉब के बारे में बताया गया है. ये जॉब, किसी खास जॉब की शर्त के साथ काम करती हैं. साथ ही, इस टेबल में उन जॉब की शर्तों के बारे में भी बताया गया है जिनके साथ WorkManager काम करता है. टेबल के पहले मौजूद खोज बार का इस्तेमाल करके, टेबल को जॉब की पाबंदी के तरीके के नाम के हिसाब से फ़िल्टर करें.

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क के लिए, ये पाबंदियां लागू होती हैं:

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% तक बेहतर बनाया