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

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

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

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

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

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

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

पक्का करें कि आपके ऐप्लिकेशन ने मेनिफ़ेस्ट में 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() को कॉल करें.

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

目前还没有支持 UIDT 作业的 Jetpack 库。因此，我们建议您使用代码来限制变更，以验证您是否在 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 के साथ काम करती हैं. टेबल को किसी जॉब कंस्ट्रेंट के तरीके के नाम से फ़िल्टर करने के लिए, टेबल से पहले मौजूद खोज बार का इस्तेमाल करें.

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