Android ऐप्लिकेशन में मैसेज पाना

Firebase सूचनाएं, सूचना पाने वाले ऐप्लिकेशन की फ़ोरग्राउंड/बैकग्राउंड स्थिति के आधार पर अलग-अलग तरीके से काम करती हैं. अगर आपको फ़ोरग्राउंड में चल रहे ऐप्लिकेशन को सूचना वाले मैसेज या डेटा मैसेज भेजने हैं, तो आपको onMessageReceived कॉलबैक को हैंडल करने के लिए कोड लिखना होगा. सूचना और डेटा मैसेज के बीच के अंतर के बारे में जानने के लिए, मैसेज के टाइप लेख पढ़ें.

मैसेज मैनेज करना

मैसेज पाने के लिए, ऐसी सेवा का इस्तेमाल करें जो FirebaseMessagingService को बढ़ाती है. आपकी सेवा को onMessageReceived और onDeletedMessages कॉलबैक को ओवरराइड करना चाहिए.

onMessageReceived की सुविधा, ज़्यादातर तरह के मैसेज के लिए उपलब्ध है. हालांकि, इन मैसेज के लिए यह सुविधा उपलब्ध नहीं है:

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

• बैकग्राउंड में सूचना और डेटा पेलोड, दोनों वाले मैसेज मिलने पर. इस मामले में, सूचना को डिवाइस की सिस्टम ट्रे में डिलीवर किया जाता है. साथ ही, डेटा पेलोड को आपके लॉन्चर ऐक्टिविटी के इंटेंट के एक्स्ट्रा में डिलीवर किया जाता है.

सारांश में:

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

अगर आपको लगता है कि आपके ऐप्लिकेशन को किसी मैसेज को प्रोसेस करने में 10 सेकंड लग सकते हैं, तो आपको WorkManager जॉब शेड्यूल करनी चाहिए या नीचे दिए गए WakeLock के दिशा-निर्देशों का पालन करना चाहिए. कुछ मामलों में, मैसेज को हैंडल करने के लिए 10 सेकंड से कम समय मिल सकता है. ऐसा onMessageReceived को कॉल करने से पहले होने वाली देरी की वजह से होता है. जैसे, ओएस में देरी, ऐप्लिकेशन के शुरू होने में लगने वाला समय, मुख्य थ्रेड का अन्य कार्रवाइयों से ब्लॉक होना या पिछले onMessageReceived कॉल में ज़्यादा समय लगना. टाइमर खत्म होने के बाद, आपके ऐप्लिकेशन पर प्रोसेस बंद करने या बैकग्राउंड में ऐप्लिकेशन चलाने की सीमाएं लागू हो सकती हैं. ध्यान रखें कि नेटवर्क लेन-देन और ऐप्लिकेशन स्टार्टअप के लिए, इंतज़ार का समय ज़्यादा हो सकता है. इसलिए, अगर आपको कोई शंका है, तो मैसेज प्रोसेसिंग को लंबे समय तक चलाने की योजना बनाएं. ऐसा तब करें, जब नेटवर्क ऐक्सेस या डेटा लोड करने की ज़्यादा ज़रूरत जैसी कोई एसिंक्रोनस डिपेंडेंसी हो.

ऐप्लिकेशन मेनिफ़ेस्ट में बदलाव करना

FirebaseMessagingService का इस्तेमाल करने के लिए, आपको अपने ऐप्लिकेशन के मेनिफ़ेस्ट में यह जानकारी जोड़नी होगी:

<service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
AndroidManifest.xml

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

कस्टम डिफ़ॉल्ट आइकॉन और कस्टम रंग सेट करने के लिए, इन लाइनों को application टैग में जोड़ें:

<!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />
AndroidManifest.xml

Android, इनके लिए कस्टम डिफ़ॉल्ट आइकॉन दिखाता है

• सूचनाएं कंपोज़ करने की सुविधा से भेजे गए सभी सूचना वाले मैसेज.
• ऐसा कोई भी सूचना मैसेज जिसमें सूचना के पेलोड में आइकॉन को साफ़ तौर पर सेट नहीं किया गया है.

Android, इन कामों के लिए पसंद के मुताबिक सेट किए गए डिफ़ॉल्ट रंग का इस्तेमाल करता है

• सूचनाएं कंपोज़ करने की सुविधा से भेजे गए सभी सूचना वाले मैसेज.
• सूचना देने वाला ऐसा कोई भी मैसेज जिसमें सूचना के पेलोड में रंग साफ़ तौर पर सेट नहीं किया गया है.

अगर कस्टम डिफ़ॉल्ट आइकॉन सेट नहीं किया गया है और सूचना के पेलोड में कोई आइकॉन सेट नहीं किया गया है, तो Android, ऐप्लिकेशन का आइकॉन दिखाता है. यह आइकॉन सफ़ेद रंग में रेंडर किया जाता है.

onMessageReceived को ओवरराइड करना

FirebaseMessagingService.onMessageReceived तरीके को बदलकर, आपको मिले RemoteMessage ऑब्जेक्ट के आधार पर कार्रवाइयां की जा सकती हैं. साथ ही, मैसेज का डेटा पाया जा सकता है:

override fun onMessageReceived(remoteMessage: RemoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: ${remoteMessage.from}")

    // Check if message contains a data payload.
    if (remoteMessage.data.isNotEmpty()) {
        Log.d(TAG, "Message data payload: ${remoteMessage.data}")

        // Check if data needs to be processed by long running job
        if (needsToBeScheduled()) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob()
        } else {
            // Handle message within 10 seconds
            handleNow()
        }
    }

    // Check if message contains a notification payload.
    remoteMessage.notification?.let {
        Log.d(TAG, "Message Notification Body: ${it.body}")
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.kt

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: " + remoteMessage.getFrom());

    // Check if message contains a data payload.
    if (remoteMessage.getData().size() > 0) {
        Log.d(TAG, "Message data payload: " + remoteMessage.getData());

        if (/* Check if data needs to be processed by long running job */ true) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob();
        } else {
            // Handle message within 10 seconds
            handleNow();
        }

    }

    // Check if message contains a notification payload.
    if (remoteMessage.getNotification() != null) {
        Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.java

FCM मैसेज हैंडल करते समय, डिवाइस को चालू रखना

अगर आपके ऐप्लिकेशन को FCM मैसेज प्रोसेस करते समय डिवाइस को चालू रखना है, तो उसे इस दौरान WakeLock को होल्ड करना होगा. इसके अलावा, उसे WorkManager जॉब बनाना होगा. WakeLocks, प्रोसेसिंग से जुड़ी उन छोटी गतिविधियों के लिए बेहतर तरीके से काम करते हैं जिनमें onMessageReceived डिफ़ॉल्ट टाइमआउट से ज़्यादा समय लग सकता है. लंबे समय तक चलने वाले वर्कफ़्लो के लिए, WakeLock के बजाय WorkManager जॉब का इस्तेमाल करना ज़्यादा सही होता है. जैसे, अपने सर्वर को एक से ज़्यादा सीरियल आरपीसी भेजना. इस सेक्शन में, हम WakeLocks का इस्तेमाल करने के तरीके पर फ़ोकस करते हैं. WakeLock, ऐप्लिकेशन के चालू रहने के दौरान डिवाइस को स्लीप मोड में जाने से रोकता है. इससे बैटरी का इस्तेमाल बढ़ सकता है. इसलिए, WakeLock का इस्तेमाल सिर्फ़ उन मामलों में किया जाना चाहिए जहां मैसेज हैंडल करते समय, आपके ऐप्लिकेशन को रोका नहीं जाना चाहिए. जैसे:

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

सबसे पहले, आपको यह पक्का करना होगा कि आपका ऐप्लिकेशन, WakeLock की अनुमति का अनुरोध करता हो. FCM SDK में यह अनुमति डिफ़ॉल्ट रूप से शामिल होती है. इसलिए, आम तौर पर कुछ भी जोड़ने की ज़रूरत नहीं होती.

<uses-permission android:name="android.permission.WAKE_LOCK" />

इसके बाद, आपके ऐप्लिकेशन को FirebaseMessagingService.onMessageReceived() कॉलबैक की शुरुआत में WakeLock हासिल करना होगा और कॉलबैक के आखिर में इसे रिलीज़ करना होगा.

ऐप्लिकेशन का कस्टम FirebaseMessagingService:

@Override
public void onMessageReceived(final RemoteMessage message) {
  // If this is a message that is time sensitive or shouldn't be interrupted
  WakeLock wakeLock = getSystemService(PowerManager.class).newWakeLock(PARTIAL_WAKE_LOCK, "myApp:messageReceived");
  try {
    wakeLock.acquire(TIMEOUT_MS);
    // handle message
    ...
  finally {
    wakeLock.release();
  }
}

onDeletedMessages को ओवरराइड करना

बैकग्राउंड में चल रहे ऐप्लिकेशन में सूचनाएं मैनेज करना

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

इसमें ऐसे मैसेज शामिल हैं जिनमें सूचना और डेटा पेलोड, दोनों शामिल होते हैं. साथ ही, इसमें Notifications console से भेजे गए सभी मैसेज भी शामिल होते हैं. इन मामलों में, सूचना को डिवाइस की सिस्टम ट्रे में डिलीवर किया जाता है. साथ ही, डेटा पेलोड को आपके लॉन्चर ऐक्टिविटी के इंटेंट के एक्स्ट्रा में डिलीवर किया जाता है.

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

डायरेक्ट बूट मोड में FCM मैसेज पाना

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

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

ज़रूरी शर्तें

• डिवाइस को डायरेक्ट बूट मोड के लिए सेट अप किया गया हो.
• डिवाइस पर Google Play services का नया वर्शन (19.0.54 या उसके बाद का वर्शन) इंस्टॉल होना चाहिए.
• FCM मैसेज पाने के लिए, ऐप्लिकेशन को FCM SDK (com.google.firebase:firebase-messaging) का इस्तेमाल करना होगा.

अपने ऐप्लिकेशन में डायरेक्ट बूट मोड में मैसेज हैंडल करने की सुविधा चालू करना

1. ऐप्लिकेशन-लेवल की Gradle फ़ाइल में, FCM डायरेक्ट बूट की सुविधा देने वाली लाइब्रेरी की डिपेंडेंसी जोड़ें:

   implementation 'com.google.firebase:firebase-messaging-directboot:20.2.0'
   

2. ऐप्लिकेशन के मेनिफ़ेस्ट में android:directBootAware="true" एट्रिब्यूट जोड़कर, ऐप्लिकेशन को FirebaseMessagingService डायरेक्ट बूट के बारे में जानकारी दें:

   <service
       android:name=".java.MyFirebaseMessagingService"
       android:exported="false"
       android:directBootAware="true">
       <intent-filter>
           <action android:name="com.google.firebase.MESSAGING_EVENT" />
       </intent-filter>
   </service>
   

यह पक्का करना ज़रूरी है कि यह FirebaseMessagingService डायरेक्ट बूट मोड में चल सके. इन ज़रूरी शर्तों को पूरा करें:

• सीधे बूट मोड में चलने के दौरान, सेवा को क्रेडेंशियल से सुरक्षित किए गए स्टोरेज को ऐक्सेस नहीं करना चाहिए.
• डायरेक्ट बूट मोड में चलने के दौरान, सेवा को ऐसे कॉम्पोनेंट इस्तेमाल करने की कोशिश नहीं करनी चाहिए जिन्हें डायरेक्ट बूट मोड के बारे में जानकारी रखने वाले कॉम्पोनेंट के तौर पर मार्क नहीं किया गया है. जैसे, Activities, BroadcastReceivers या अन्य Services.
• सेवा में इस्तेमाल होने वाली किसी भी लाइब्रेरी को, क्रेडेंशियल से सुरक्षित किए गए स्टोरेज को ऐक्सेस नहीं करना चाहिए. साथ ही, डायरेक्ट बूट मोड में चलते समय, non-directBootAware कॉम्पोनेंट को कॉल नहीं करना चाहिए. इसका मतलब है कि ऐप्लिकेशन में इस्तेमाल की जा रही किसी भी लाइब्रेरी को सेवा से कॉल किया जाता है. इसलिए, उसे डायरेक्ट बूट मोड के बारे में पता होना चाहिए. इसके अलावा, ऐप्लिकेशन को यह जांच करनी होगी कि वह डायरेक्ट बूट मोड में चल रहा है या नहीं. अगर वह डायरेक्ट बूट मोड में चल रहा है, तो उसे लाइब्रेरी को कॉल नहीं करना चाहिए. उदाहरण के लिए, Firebase SDK टूल डायरेक्ट बूट मोड के साथ काम करते हैं. इन्हें डायरेक्ट बूट मोड में ऐप्लिकेशन क्रैश किए बिना ऐप्लिकेशन में शामिल किया जा सकता है. हालांकि, कई Firebase API, डायरेक्ट बूट मोड में कॉल किए जाने की सुविधा के साथ काम नहीं करते.
• अगर ऐप्लिकेशन, कस्टम Application का इस्तेमाल कर रहा है, तो Application को भी डायरेक्ट बूट के बारे में पता होना चाहिए. डायरेक्ट बूट मोड में, क्रेडेंशियल से सुरक्षित स्टोरेज को ऐक्सेस नहीं किया जा सकता.

डायरेक्ट बूट मोड में डिवाइसों को मैसेज भेजने के बारे में जानकारी पाने के लिए, डायरेक्ट बूट मोड में मैसेज भेजना लेख पढ़ें.