कलेक्शन विजेट का इस्तेमाल करना

Compose को आज़माएं
Jetpack Compose, Android के लिए सुझाई गई यूज़र इंटरफ़ेस (यूआई) टूलकिट है. Compose-स्टाइल एपीआई का इस्तेमाल करके विजेट बनाने का तरीका जानें.
Jetpack Glance →

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

ये विजेट, RemoteViewsService का इस्तेमाल करके, रिमोट डेटा से बैकअप किए गए कलेक्शन दिखाते हैं. जैसे, कॉन्टेंट देने वाले से मिला डेटा. विजेट, इनमें से किसी एक व्यू टाइप का इस्तेमाल करके डेटा दिखाता है. इन्हें कलेक्शन व्यू कहा जाता है:

ListView: ऐसा व्यू जो आइटम को वर्टिकल स्क्रोलिंग लिस्ट में दिखाता है.

GridView: ऐसा व्यू जिसमें आइटम, दो डाइमेंशन वाले स्क्रोलिंग ग्रिड में दिखते हैं.

StackView: स्टैक किया गया कार्ड व्यू—रोलोडेक्स की तरह—जहां उपयोगकर्ता पिछले या अगले कार्ड को देखने के लिए, सामने वाले कार्ड को ऊपर या नीचे फ़्लिक कर सकता है.

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

ये कलेक्शन व्यू, रिमोट डेटा से मिले कलेक्शन दिखाते हैं. इसलिए, ये अपने यूज़र इंटरफ़ेस को अपने डेटा से जोड़ने के लिए, Adapter का इस्तेमाल करते हैं. Adapter, डेटा के सेट से अलग-अलग आइटम को अलग-अलग View ऑब्जेक्ट से बाइंड करता है.

इन कलेक्शन व्यू को अडैप्टर की मदद से बनाया जाता है. इसलिए, Android फ़्रेमवर्क में अतिरिक्त आर्किटेक्चर शामिल होना चाहिए, ताकि विजेट में इनका इस्तेमाल किया जा सके. विजेट के संदर्भ में, Adapter को RemoteViewsFactory से बदल दिया जाता है. यह Adapter इंटरफ़ेस के आस-पास एक पतला रैपर होता है. कलेक्शन में मौजूद किसी खास आइटम के लिए अनुरोध किए जाने पर, RemoteViewsFactory उस आइटम को बनाता है और कलेक्शन के लिए RemoteViews ऑब्जेक्ट के तौर पर दिखाता है. अपने विजेट में कलेक्शन व्यू शामिल करने के लिए, RemoteViewsService और RemoteViewsFactory को लागू करें.

RemoteViewsService एक ऐसी सेवा है जो रिमोट अडैप्टर को RemoteViews ऑब्जेक्ट का अनुरोध करने की अनुमति देती है. RemoteViewsFactory, कलेक्शन व्यू और उस व्यू के डेटा के बीच अडैप्टर के लिए एक इंटरफ़ेस है. जैसे, ListView, GridView, और StackView. StackWidget सैंपल से, इस सेवा और इंटरफ़ेस को लागू करने के लिए, छोटे-मोटे बदलाव वाले कोड का एक उदाहरण यहां दिया गया है:

class StackWidgetService : RemoteViewsService() {
    override fun onGetViewFactory(intent: Intent): RemoteViewsFactory =
        StackRemoteViewsFactory(this.applicationContext, intent)
}

class StackRemoteViewsFactory(
    private val context: Context, intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

    // See the RemoteViewsFactory API reference for the full list of methods to implement.

}

सैंपल ऐप्लिकेशन

इस सेक्शन में दिए गए कोड के अंश भी StackWidget सैंपल से लिए गए हैं:

स्टैक किए गए व्यू दिखाने वाला StackWidget
पहली इमेज. StackWidget.

इस सैंपल में, दस व्यू का एक स्टैक शामिल है. इसमें शून्य से लेकर नौ तक की वैल्यू दिखती हैं. सैंपल विजेट में ये मुख्य व्यवहार होते हैं:

  • उपयोगकर्ता, विजेट में टॉप व्यू को वर्टिकल तौर पर फ़्लिंग करके, अगला या पिछला व्यू देख सकता है. यह StackView का पहले से मौजूद व्यवहार है.

  • उपयोगकर्ता के किसी इंटरैक्शन के बिना, विजेट अपने-आप एक के बाद एक व्यू दिखाता है. यह स्लाइड शो की तरह होता है. ऐसा res/xml/stackwidgetinfo.xml फ़ाइल में मौजूद android:autoAdvanceViewId="@id/stack_view" सेटिंग की वजह से होता है. यह सेटिंग, व्यू आईडी पर लागू होती है. इस मामले में, यह स्टैक व्यू का आईडी है.

  • अगर उपयोगकर्ता टॉप व्यू को टच करता है, तो विजेट Toast मैसेज "टच किया गया व्यू n" दिखाता है. यहां n, टच किए गए व्यू का इंडेक्स (पोज़िशन) है. बिहेवियर लागू करने के तरीके के बारे में ज़्यादा जानने के लिए, अलग-अलग आइटम में बिहेवियर जोड़ना सेक्शन देखें.

कलेक्शन के साथ विजेट लागू करना

कलेक्शन वाले विजेट को लागू करने के लिए, किसी भी विजेट को लागू करने का तरीका अपनाएं. इसके बाद, कुछ और चरण पूरे करें: मेनिफ़ेस्ट में बदलाव करें, विजेट लेआउट में कलेक्शन व्यू जोड़ें, और अपने AppWidgetProvider सबक्लास में बदलाव करें.

कलेक्शन वाले विजेट के लिए मेनिफ़ेस्ट

मेनिफ़ेस्ट में विजेट का एलान करें सेक्शन में बताई गई ज़रूरी शर्तों के अलावा, आपको यह पक्का करना होगा कि कलेक्शन वाले विजेट, आपके RemoteViewsService से बाइंड हो सकें. इसके लिए, अपनी मेनिफ़ेस्ट फ़ाइल में BIND_REMOTEVIEWS अनुमति के साथ सेवा का एलान करें. इससे अन्य ऐप्लिकेशन, आपके विजेट के डेटा को बिना अनुमति के ऐक्सेस नहीं कर पाते.

उदाहरण के लिए, कलेक्शन व्यू को पॉप्युलेट करने के लिए, RemoteViewsService का इस्तेमाल करने वाला विजेट बनाते समय, मेनिफ़ेस्ट एंट्री कुछ इस तरह दिख सकती है:

<service android:name="MyWidgetService"
    android:permission="android.permission.BIND_REMOTEVIEWS" />

इस उदाहरण में, android:name="MyWidgetService", RemoteViewsService की सबक्लास है.

कलेक्शन वाले विजेट के लिए लेआउट

विजेट लेआउट की एक्सएमएल फ़ाइल के लिए मुख्य ज़रूरी शर्त यह है कि उसमें इनमें से कोई एक कलेक्शन व्यू शामिल हो: ListView, GridView, StackView या AdapterViewFlipper. StackWidget सैंपल के लिए, widget_layout.xml फ़ाइल यहां दी गई है:

<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <StackView
        android:id="@+id/stack_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center"
        android:loopViews="true" />
    <TextView
        android:id="@+id/empty_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center"
        android:background="@drawable/widget_item_background"
        android:textColor="#ffffff"
        android:textStyle="bold"
        android:text="@string/empty_view_text"
        android:textSize="20sp" />
</FrameLayout>

ध्यान दें कि खाली व्यू, उस कलेक्शन व्यू के सिबलिंग होने चाहिए जिसके लिए खाली व्यू, खाली स्थिति को दिखाता है.

अपने पूरे विजेट के लिए लेआउट फ़ाइल के अलावा, एक और लेआउट फ़ाइल बनाएं. इसमें कलेक्शन में मौजूद हर आइटम के लिए लेआउट तय किया जाता है. उदाहरण के लिए, किताबों के कलेक्शन में मौजूद हर किताब के लिए लेआउट. StackWidget सैंपल में सिर्फ़ एक आइटम लेआउट फ़ाइल, widget_item.xml है, क्योंकि सभी आइटम एक ही लेआउट का इस्तेमाल करते हैं.

कलेक्शन वाले विजेट के लिए AppWidgetProvider क्लास

सामान्य विजेट की तरह ही, आपके AppWidgetProvider सबक्लास का ज़्यादातर कोड आम तौर पर onUpdate() में जाता है. कलेक्शन वाले विजेट बनाते समय, onUpdate() के लिए आपके लागू करने के तरीके में मुख्य अंतर यह है कि आपको setRemoteAdapter() को कॉल करना होगा. इससे कलेक्शन व्यू को पता चलता है कि उसे अपना डेटा कहां से मिलेगा. इसके बाद, RemoteViewsService आपके RemoteViewsFactory के लागू होने की जानकारी दिखा सकता है. साथ ही, विजेट सही डेटा दिखा सकता है. इस तरीके को कॉल करते समय, एक ऐसा इंटेंट पास करें जो RemoteViewsService को लागू करने के तरीके और उस विजेट आईडी पर ले जाए जिससे विजेट को अपडेट किया जा सके.

उदाहरण के लिए, यहां बताया गया है कि StackWidget सैंपल, onUpdate() कॉलबैक के तरीके को कैसे लागू करता है, ताकि RemoteViewsService को विजेट कलेक्शन के लिए रिमोट अडैप्टर के तौर पर सेट किया जा सके:

override fun onUpdate(
    context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray
) {
    // Update each of the widgets with the remote adapter.
    appWidgetIds.forEach { appWidgetId ->

        // Set up the intent that starts the StackViewService, which
        // provides the views for this collection.
        val intent = Intent(context, StackWidgetService::class.java).apply {
            // Add the widget ID to the intent extras.
            putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
            data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
        }
        // Instantiate the RemoteViews object for the widget layout.
        val views = RemoteViews(context.packageName, R.layout.widget_layout).apply {
            // Set up the RemoteViews object to use a RemoteViews adapter.
            // This adapter connects to a RemoteViewsService through the
            // specified intent.
            // This is how you populate the data.
            setRemoteAdapter(R.id.stack_view, intent)

            // The empty view is displayed when the collection has no items.
            // It must be in the same layout used to instantiate the
            // RemoteViews object.
            setEmptyView(R.id.stack_view, R.id.empty_view)
        }

        // Do additional processing specific to this widget.

        appWidgetManager.updateAppWidget(appWidgetId, views)
    }
    super.onUpdate(context, appWidgetManager, appWidgetIds)
}

डेटा सेव करना

इस पेज पर बताया गया है कि RemoteViewsService सबक्लास, RemoteViewsFactory उपलब्ध कराता है. इसका इस्तेमाल, रिमोट कलेक्शन व्यू को पॉप्युलेट करने के लिए किया जाता है.

खास तौर पर, यह तरीका अपनाएं:

  1. सबक्लास RemoteViewsService. RemoteViewsService वह सेवा है जिसकी मदद से, रिमोट अडैप्टर RemoteViews का अनुरोध कर सकता है.

  2. अपनी RemoteViewsService सबक्लास में, RemoteViewsFactory इंटरफ़ेस को लागू करने वाली क्लास शामिल करें. RemoteViewsFactory, रिमोट कलेक्शन व्यू (जैसे, ListView, GridView, StackView) और उस व्यू के लिए मौजूद डेटा के बीच अडैप्टर के लिए एक इंटरफ़ेस है. आपके लागू किए गए तरीके की मदद से, डेटासेट में मौजूद हर आइटम के लिए एक RemoteViews ऑब्जेक्ट बनाया जाता है. यह इंटरफ़ेस, Adapter के लिए एक थिन रैपर है.

अपनी सेवा के किसी एक इंस्टेंस या उसमें मौजूद किसी डेटा पर भरोसा नहीं किया जा सकता. अपने RemoteViewsService में डेटा तब तक सेव न करें, जब तक वह स्टैटिक न हो. अगर आपको अपने विजेट का डेटा सेव रखना है, तो सबसे अच्छा तरीका यह है कि आप ContentProvider का इस्तेमाल करें. इसका डेटा, प्रोसेस लाइफ़साइकल के बाद भी सेव रहता है. उदाहरण के लिए, किराने की दुकान का विजेट, किराने की सूची के हर आइटम की स्थिति को SQL डेटाबेस जैसी किसी स्थायी जगह पर सेव कर सकता है.

RemoteViewsService को लागू करने का मुख्य कॉन्टेंट, इसका RemoteViewsFactory है. इसके बारे में यहां बताया गया है.

RemoteViewsFactory इंटरफ़ेस

RemoteViewsFactory इंटरफ़ेस को लागू करने वाली आपकी कस्टम क्लास, विजेट को उसके कलेक्शन में मौजूद आइटम का डेटा उपलब्ध कराती है. इसके लिए, यह आपके विजेट आइटम की एक्सएमएल लेआउट फ़ाइल को डेटा सोर्स के साथ जोड़ता है. डेटा का यह सोर्स, डेटाबेस से लेकर कलेक्शन तक कुछ भी हो सकता है. StackWidget सैंपल में, डेटा सोर्स WidgetItems का कलेक्शन है. RemoteViewsFactory, डेटा को रिमोट कलेक्शन व्यू से जोड़ने के लिए, अडैप्टर के तौर पर काम करता है.

RemoteViewsFactory सबक्लास के लिए, आपको दो सबसे ज़रूरी तरीके लागू करने होंगे. ये तरीके हैं: onCreate() और getViewAt().

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

यहां StackWidget सैंपल के RemoteViewsFactory को लागू करने का एक अंश दिया गया है. इसमें onCreate() तरीके के कुछ हिस्से दिखाए गए हैं:

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
    private val context: Context
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating content,
        // must be deferred to onDataSetChanged() or getViewAt(). Taking
        // more than 20 seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
    }

}

RemoteViewsFactory तरीका getViewAt(), डेटासेट में दिए गए position पर मौजूद डेटा से जुड़ा RemoteViews ऑब्जेक्ट दिखाता है. यहां StackWidget सैंपल के RemoteViewsFactory को लागू करने का एक अंश दिया गया है:

override fun getViewAt(position: Int): RemoteViews {
    // Construct a remote views item based on the widget item XML file
    // and set the text based on the position.
    return RemoteViews(context.packageName, R.layout.widget_item).apply {
        setTextViewText(R.id.widget_item, widgetItems[position].text)
    }
}

अलग-अलग आइटम के लिए व्यवहार जोड़ना

पिछले सेक्शन में, डेटा को विजेट कलेक्शन से बाइंड करने का तरीका बताया गया है. लेकिन, अगर आपको अपने कलेक्शन व्यू में मौजूद अलग-अलग आइटम में डाइनैमिक बिहेवियर जोड़ना है, तो क्या करना होगा?

onUpdate() क्लास की मदद से इवेंट मैनेज करना लेख में बताया गया है कि आम तौर पर, किसी ऑब्जेक्ट के क्लिक व्यवहार को सेट करने के लिए, setOnClickPendingIntent() का इस्तेमाल किया जाता है. जैसे, किसी बटन से Activity को लॉन्च करना. हालांकि, किसी कलेक्शन आइटम में चाइल्ड व्यू के लिए इस तरीके की अनुमति नहीं है. उदाहरण के लिए, Gmail विजेट में ऐप्लिकेशन को लॉन्च करने वाला ग्लोबल बटन सेट अप करने के लिए, setOnClickPendingIntent() का इस्तेमाल किया जा सकता है. हालांकि, सूची के अलग-अलग आइटम पर इसका इस्तेमाल नहीं किया जा सकता.

इसके बजाय, किसी कलेक्शन में मौजूद अलग-अलग आइटम पर क्लिक करने के बाद होने वाली कार्रवाई को जोड़ने के लिए, setOnClickFillInIntent() का इस्तेमाल करें. अपने कलेक्शन व्यू के लिए, पेंडिंग इंटेंट टेंप्लेट सेट अप करें. साथ ही, अपने RemoteViewsFactory का इस्तेमाल करके, कलेक्शन में मौजूद हर आइटम पर फ़िल-इन इंटेंट सेट करें.

इस सेक्शन में, StackWidget सैंपल का इस्तेमाल करके, अलग-अलग आइटम में व्यवहार जोड़ने का तरीका बताया गया है. StackWidget सैंपल में, अगर उपयोगकर्ता टॉप व्यू को टच करता है, तो विजेट Toast मैसेज "टच किया गया व्यू n" दिखाता है. यहां n, टच किए गए व्यू का इंडेक्स (पोज़िशन) है. आइए जानते हैं कि ऐसा कैसे करें:

  • StackWidgetProvider—AppWidgetProvider का सबक्लास—TOAST_ACTION नाम की कस्टम कार्रवाई के साथ एक पेंडिंग इंटेंट बनाता है.

  • जब उपयोगकर्ता किसी व्यू को टच करता है, तो इंटेंट ट्रिगर होता है और TOAST_ACTION को ब्रॉडकास्ट करता है.

  • इस ब्रॉडकास्ट को StackWidgetProvider क्लास के onReceive() तरीके से इंटरसेप्ट किया जाता है. साथ ही, विजेट टच किए गए व्यू के लिए Toast मैसेज दिखाता है. कलेक्शन के आइटम का डेटा, RemoteViewsFactory RemoteViewsService के ज़रिए उपलब्ध कराता है.

पेंडिंग इंटेंट टेंप्लेट सेट अप करना

StackWidgetProvider (AppWidgetProvider का सबक्लास) पेंडिंग इंटेंट सेट अप करता है. कलेक्शन के अलग-अलग आइटम, अपने पेंडिंग इंटेंट सेट अप नहीं कर सकते. इसके बजाय, कलेक्शन के तौर पर एक पेंडिंग इंटेंट टेंप्लेट सेट अप किया जाता है. साथ ही, अलग-अलग आइटम के लिए, फ़िल-इन इंटेंट सेट किया जाता है, ताकि हर आइटम के लिए यूनीक व्यवहार बनाया जा सके.

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

const val TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION"
const val EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM"

class StackWidgetProvider : AppWidgetProvider() {

    // ...

    // Called when the BroadcastReceiver receives an Intent broadcast.
    // Checks whether the intent's action is TOAST_ACTION. If it is, the
    // widget displays a Toast message for the current item.
    override fun onReceive(context: Context, intent: Intent) {
        val mgr: AppWidgetManager = AppWidgetManager.getInstance(context)
        if (intent.action == TOAST_ACTION) {
            val appWidgetId: Int = intent.getIntExtra(
                AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID
            )
            // EXTRA_ITEM represents a custom value provided by the Intent
            // passed to the setOnClickFillInIntent() method to indicate the
            // position of the clicked item. See StackRemoteViewsFactory in
            // Set the fill-in Intent for details.
            val viewIndex: Int = intent.getIntExtra(EXTRA_ITEM, 0)
            Toast.makeText(context, "Touched view $viewIndex", Toast.LENGTH_SHORT).show()
        }
        super.onReceive(context, intent)
    }

    override fun onUpdate(
        context: Context,
        appWidgetManager: AppWidgetManager,
        appWidgetIds: IntArray
    ) {
        // Update each of the widgets with the remote adapter.
        appWidgetIds.forEach { appWidgetId ->

            // Sets up the intent that points to the StackViewService that
            // provides the views for this collection.
            val intent = Intent(context, StackWidgetService::class.java).apply {
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                // When intents are compared, the extras are ignored, so embed
                // the extra sinto the data so that the extras are not ignored.
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
            }
            val rv = RemoteViews(context.packageName, R.layout.widget_layout).apply {
                setRemoteAdapter(R.id.stack_view, intent)

                // The empty view is displayed when the collection has no items.
                // It must be a sibling of the collection view.
                setEmptyView(R.id.stack_view, R.id.empty_view)
            }

            // This section makes it possible for items to have individualized
            // behavior. It does this by setting up a pending intent template.
            // Individuals items of a collection can't set up their own pending
            // intents. Instead, the collection as a whole sets up a pending
            // intent template, and the individual items set a fillInIntent
            // to create unique behavior on an item-by-item basis.
            val toastPendingIntent: PendingIntent = Intent(
                context,
                StackWidgetProvider::class.java
            ).run {
                // Set the action for the intent.
                // When the user touches a particular view, it has the effect of
                // broadcasting TOAST_ACTION.
                action = TOAST_ACTION
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))

                // The template must be mutable, because each item fills in its
                // own extras through setOnClickFillInIntent().
                PendingIntent.getBroadcast(
                    context, 0, this,
                    PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE
                )
            }
            rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent)

            appWidgetManager.updateAppWidget(appWidgetId, rv)
        }
        super.onUpdate(context, appWidgetManager, appWidgetIds)
    }
}

इंटेंट सेट करना

आपके RemoteViewsFactory को कलेक्शन में मौजूद हर आइटम पर, फ़िल-इन इंटेंट सेट करना होगा. इससे, किसी आइटम पर क्लिक करने पर होने वाली अलग-अलग कार्रवाइयों के बीच अंतर किया जा सकता है. इसके बाद, फ़िल-इन इंटेंट को PendingIntent टेंप्लेट के साथ जोड़ दिया जाता है, ताकि आइटम पर टैप करने पर लागू होने वाले फ़ाइनल इंटेंट का पता लगाया जा सके.

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
    private val context: Context,
    intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>
    private val appWidgetId: Int = intent.getIntExtra(
        AppWidgetManager.EXTRA_APPWIDGET_ID,
        AppWidgetManager.INVALID_APPWIDGET_ID
    )

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data source.
        // Heavy lifting, such as downloading or creating content, must be
        // deferred to onDataSetChanged() or getViewAt(). Taking more than 20
        // seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
        // ...
    }

    // ...

    override fun getViewAt(position: Int): RemoteViews {
        // Construct a remote views item based on the widget item XML file
        // and set the text based on the position.
        return RemoteViews(context.packageName, R.layout.widget_item).apply {
            setTextViewText(R.id.widget_item, widgetItems[position].text)

            // Set a fill-intent to fill in the pending intent template.
            // that is set on the collection view in StackWidgetProvider.
            val fillInIntent = Intent().apply {
                Bundle().also { extras ->
                    extras.putInt(EXTRA_ITEM, position)
                    putExtras(extras)
                }
            }
            // Make it possible to distinguish the individual on-click
            // action of a given item.
            setOnClickFillInIntent(R.id.widget_item, fillInIntent)
            // ...
        }
    }
    // ...
}

कलेक्शन के डेटा को अप-टू-डेट रखना

दूसरी इमेज में, कलेक्शन का इस्तेमाल करने वाले विजेट में अपडेट फ़्लो को दिखाया गया है. इससे पता चलता है कि विजेट कोड, RemoteViewsFactory के साथ कैसे इंटरैक्ट करता है और अपडेट कैसे ट्रिगर किए जा सकते हैं:

अपडेट के दौरान RemoteViewsFactory के साथ इंटरैक्शन
दूसरी इमेज. अपडेट के दौरान RemoteViewsFactory के साथ इंटरैक्शन.

कलेक्शन का इस्तेमाल करने वाले विजेट, उपयोगकर्ताओं को अप-टू-डेट कॉन्टेंट उपलब्ध करा सकते हैं. उदाहरण के लिए, Gmail विजेट से उपयोगकर्ताओं को उनके इनबॉक्स का स्नैपशॉट मिलता है. ऐसा करने के लिए, अपने RemoteViewsFactory और कलेक्शन व्यू को ट्रिगर करें, ताकि नया डेटा फ़ेच और डिसप्ले किया जा सके.

ऐसा करने के लिए, notifyAppWidgetViewDataChanged() को कॉल करने के लिए, AppWidgetManager का इस्तेमाल करें. इस कॉल के नतीजे के तौर पर, आपके RemoteViewsFactory ऑब्जेक्ट के onDataSetChanged() तरीके पर कॉलबैक होता है. इससे आपको कोई भी नया डेटा फ़ेच करने की सुविधा मिलती है.

onDataSetChanged() कॉलबैक में, प्रोसेसिंग से जुड़े मुश्किल ऑपरेशन को सिंक्रोनस तरीके से किया जा सकता है. यह कॉल, RemoteViewsFactory से मेटाडेटा या व्यू डेटा फ़ेच होने से पहले पूरा हो जाता है. getViewAt() तरीके में, प्रोसेसिंग-इंटेंसिव ऑपरेशन भी किए जा सकते हैं. अगर इस कॉल में ज़्यादा समय लगता है, तो लोडिंग व्यू तब तक कलेक्शन व्यू की सही जगह पर दिखता है, जब तक कि यह वापस नहीं आ जाता. लोडिंग व्यू को RemoteViewsFactory ऑब्जेक्ट के getLoadingView() तरीके से तय किया जाता है.

किसी कलेक्शन को सीधे पास करने के लिए, RemoteCollectionItems का इस्तेमाल करना

Android 12 (एपीआई लेवल 31) में setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) तरीका जोड़ा गया है. इसकी मदद से, कलेक्शन व्यू को पॉप्युलेट करते समय आपका ऐप्लिकेशन सीधे तौर पर कलेक्शन को पास कर सकता है. अगर आपने इस तरीके का इस्तेमाल करके अपना अडैप्टर सेट किया है, तो आपको RemoteViewsFactory लागू करने की ज़रूरत नहीं है. साथ ही, आपको notifyAppWidgetViewDataChanged() को कॉल करने की ज़रूरत नहीं है.

इससे अडैप्टर में जानकारी भरना आसान हो जाता है. साथ ही, जब उपयोगकर्ता सूची को स्क्रोल करके नए आइटम देखते हैं, तो नए आइटम भरने में लगने वाला समय भी कम हो जाता है. अडैप्टर सेट करने का यह तरीका तब तक सही है, जब तक कलेक्शन आइटम का सेट छोटा है. हालांकि, उदाहरण के लिए, अगर आपके कलेक्शन में setImageViewBitmap को पास किए जा रहे कई Bitmaps शामिल हैं, तो यह तरीका ठीक से काम नहीं करता.

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

यहां आसान RemoteViews कलेक्शन लागू करने का एक उदाहरण दिया गया है.

val itemLayouts = listOf(
    R.layout.item_type_1,
    R.layout.item_type_2,
    // ...
)

remoteView.setRemoteAdapter(
    R.id.list_view,
    RemoteViews.RemoteCollectionItems.Builder()
        .addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1))
        .addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2))
        // ...
        .setViewTypeCount(itemLayouts.count())
        .build()
)