Android पर Firebase क्लाउड से मैसेज वाला क्लाइंट ऐप्लिकेशन सेट अप करना

FCM क्लाइंट के लिए, Android 5.0 या इसके बाद के वर्शन वाले डिवाइसों की ज़रूरत होती है. साथ ही, उन पर Google Play Store ऐप्लिकेशन भी इंस्टॉल होना चाहिए. इसके अलावा, Google API के साथ Android 5.0 पर काम करने वाला एमुलेटर भी इस्तेमाल किया जा सकता है. ध्यान दें कि आपके पास अपने Android ऐप्लिकेशन को सिर्फ़ Google Play Store के ज़रिए डिप्लॉय करने का विकल्प नहीं है.

SDK टूल सेट अप करें

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

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

अपने ऐप्लिकेशन के मेनिफ़ेस्ट में ये चीज़ें जोड़ें:

  • ऐसी सेवा जो FirebaseMessagingService को बढ़ाती है. अगर आपको बैकग्राउंड में ऐप्लिकेशन पर सूचनाएं पाने के अलावा, मैसेज मैनेज करने की सुविधा चाहिए, तो यह ज़रूरी है. फ़ोरग्राउंड में चलने वाले ऐप्लिकेशन में सूचनाएं पाने, डेटा पेलोड पाने, अपस्ट्रीम मैसेज भेजने वगैरह के लिए, आपको इस सेवा को बढ़ाना होगा.
    • <service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
    AndroidManifest.xml
  • (ज़रूरी नहीं) ऐप्लिकेशन कॉम्पोनेंट में, डिफ़ॉल्ट सूचना आइकॉन और रंग सेट करने के लिए मेटाडेटा एलिमेंट. जब इनकमिंग मैसेज में आइकॉन या रंग साफ़ तौर पर सेट नहीं किया जाता, तो Android इन वैल्यू का इस्तेमाल करता है.
    • <!-- 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 8.0 (एपीआई लेवल 26) और इसके बाद के वर्शन पर, नोटिफ़िकेशन चैनल काम करते हैं. साथ ही, इनका इस्तेमाल करने का सुझाव दिया जाता है. FCM, बुनियादी सेटिंग के साथ डिफ़ॉल्ट सूचना चैनल उपलब्ध कराता है. अगर आपको अपने डिफ़ॉल्ट चैनल को बनाना और उसका इस्तेमाल करना है, तो default_notification_channel_id को अपने सूचना चैनल ऑब्जेक्ट के आईडी पर सेट करें, जैसा कि दिखाया गया है. जब इनकमिंग मैसेज में साफ़ तौर पर कोई सूचना चैनल सेट नहीं किया जाता है, तो FCM इस वैल्यू का इस्तेमाल करेगा. ज़्यादा जानने के लिए, सूचना चैनल मैनेज करना लेख पढ़ें. 
    • <meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="@string/default_notification_channel_id" />
    AndroidManifest.xml

Android 13 और उसके बाद के वर्शन पर, रनटाइम में सूचना भेजने की अनुमति का अनुरोध करना

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

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

रनटाइम की नई अनुमति का अनुरोध करने के लिए:

Kotlin+KTX

// Declare the launcher at the top of your Activity/Fragment:
private val requestPermissionLauncher = registerForActivityResult(
    ActivityResultContracts.RequestPermission(),
) { isGranted: Boolean ->
    if (isGranted) {
        // FCM SDK (and your app) can post notifications.
    } else {
        // TODO: Inform user that that your app will not show notifications.
    }
}

private fun askNotificationPermission() {
    // This is only necessary for API level >= 33 (TIRAMISU)
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
            PackageManager.PERMISSION_GRANTED
        ) {
            // FCM SDK (and your app) can post notifications.
        } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
            // TODO: display an educational UI explaining to the user the features that will be enabled
            //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
            //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
            //       If the user selects "No thanks," allow the user to continue without notifications.
        } else {
            // Directly ask for the permission
            requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
        }
    }
}
MainActivity.kt

Java

// Declare the launcher at the top of your Activity/Fragment:
private final ActivityResultLauncher<String> requestPermissionLauncher =
        registerForActivityResult(new ActivityResultContracts.RequestPermission(), isGranted -> {
            if (isGranted) {
                // FCM SDK (and your app) can post notifications.
            } else {
                // TODO: Inform user that that your app will not show notifications.
            }
        });

private void askNotificationPermission() {
    // This is only necessary for API level >= 33 (TIRAMISU)
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
                PackageManager.PERMISSION_GRANTED) {
            // FCM SDK (and your app) can post notifications.
        } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
            // TODO: display an educational UI explaining to the user the features that will be enabled
            //       by them granting the POST_NOTIFICATION permission. This UI should provide the user
            //       "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
            //       If the user selects "No thanks," allow the user to continue without notifications.
        } else {
            // Directly ask for the permission
            requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS);
        }
    }
}
MainActivity.java

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

आपके ऐप्लिकेशन को उपयोगकर्ता से POST_NOTIFICATIONS अनुमति कब लेनी चाहिए, इस बारे में सबसे सही तरीके जानने के लिए, सूचना के रनटाइम की अनुमति देखें.

Android 12L (एपीआई लेवल 32) या इससे पहले के वर्शन को टारगेट करने वाले ऐप्लिकेशन के लिए, सूचना की अनुमतियां

जब आपका ऐप्लिकेशन पहली बार सूचना चैनल बनाता है, तब Android उपयोगकर्ता से अनुमति मांगता है. ऐसा तब तक होता है, जब तक ऐप्लिकेशन फ़ोरग्राउंड में रहता है. हालांकि, चैनल बनाने और अनुमति के अनुरोध करने के समय से जुड़ी कुछ अहम बातें ध्यान में रखें:

  • अगर आपका ऐप्लिकेशन बैकग्राउंड में चलने के दौरान अपना पहला सूचना चैनल बनाता है (FCM सूचना मिलने पर FCM SDK टूल ऐसा करता है), तो Android सूचना दिखाने की अनुमति नहीं देगा. साथ ही, जब तक आपका ऐप्लिकेशन अगली बार नहीं खोला जाता, तब तक उपयोगकर्ता को सूचना की अनुमति के लिए नहीं कहा जाएगा. इसका मतलब है कि आपका ऐप्लिकेशन खुलने और उपयोगकर्ता की अनुमति मिलने से पहले मिली सभी सूचनाएं मिट जाएंगी.
  • हमारा सुझाव है कि आप अपने ऐप्लिकेशन को Android 13 और उसके बाद के वर्शन को टारगेट करने के लिए अपडेट करें. इससे, अनुमति का अनुरोध करने के लिए, प्लैटफ़ॉर्म के एपीआई का फ़ायदा लिया जा सकता है. अगर ऐसा करना संभव नहीं है, तो आपके ऐप्लिकेशन को ऐप्लिकेशन पर कोई सूचना भेजने से पहले, सूचना की अनुमति वाला डायलॉग बॉक्स ट्रिगर करने के लिए सूचना चैनल बनाना चाहिए. इससे यह पक्का किया जा सकेगा कि कोई सूचना न छूटे. ज़्यादा जानकारी के लिए, सूचना की अनुमति से जुड़े सबसे सही तरीके देखें.

ज़रूरी नहीं: POST_NOTIFICATIONS अनुमति हटाएं

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

<uses-permission android:name="android.permission.POST_NOTIFICATIONS" tools:node="remove"/>

डिवाइस रजिस्टर करने के लिए मिला टोकन ऐक्सेस करना

आपके ऐप्लिकेशन के शुरू होने पर, FCM SDK टूल, क्लाइंट ऐप्लिकेशन इंस्टेंस के लिए रजिस्ट्रेशन टोकन जनरेट करता है. अगर आपको किसी एक डिवाइस को टारगेट करना है या डिवाइस ग्रुप बनाना है, तो आपको FirebaseMessagingService को एक्सटेंड करके और onNewToken को बदलकर, इस टोकन को ऐक्सेस करना होगा.

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

रजिस्ट्रेशन टोकन तब बदल सकता है, जब:

  • ऐप्लिकेशन को नए डिवाइस पर वापस लाया गया
  • जब उपयोगकर्ता ऐप्लिकेशन को अनइंस्टॉल करता है/फिर से इंस्टॉल करता है
  • उपयोगकर्ता, ऐप्लिकेशन का डेटा मिटाता है.

मौजूदा रजिस्ट्रेशन टोकन वापस पाना

मौजूदा टोकन वापस पाने के लिए, FirebaseMessaging.getInstance().getToken() को कॉल करें:

Kotlin+KTX

FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task ->
    if (!task.isSuccessful) {
        Log.w(TAG, "Fetching FCM registration token failed", task.exception)
        return@OnCompleteListener
    }

    // Get new FCM registration token
    val token = task.result

    // Log and toast
    val msg = getString(R.string.msg_token_fmt, token)
    Log.d(TAG, msg)
    Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
})

Java

FirebaseMessaging.getInstance().getToken()
    .addOnCompleteListener(new OnCompleteListener<String>() {
        @Override
        public void onComplete(@NonNull Task<String> task) {
          if (!task.isSuccessful()) {
            Log.w(TAG, "Fetching FCM registration token failed", task.getException());
            return;
          }

          // Get new FCM registration token
          String token = task.getResult();

          // Log and toast
          String msg = getString(R.string.msg_token_fmt, token);
          Log.d(TAG, msg);
          Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
        }
    });

टोकन जनरेशन को मॉनिटर करना

नया टोकन जनरेट होने पर, onNewToken कॉलबैक ट्रिगर होता है.

Kotlin+KTX

/**
 * Called if the FCM registration token is updated. This may occur if the security of
 * the previous token had been compromised. Note that this is called when the
 * FCM registration token is initially generated so this is where you would retrieve the token.
 */
override fun onNewToken(token: String) {
    Log.d(TAG, "Refreshed token: $token")

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token)
}
MyFirebaseMessagingService.kt

Java

/**
 * There are two scenarios when onNewToken is called:
 * 1) When a new token is generated on initial app startup
 * 2) Whenever an existing token is changed
 * Under #2, there are three scenarios when the existing token is changed:
 * A) App is restored to a new device
 * B) User uninstalls/reinstalls the app
 * C) User clears app data
 */
@Override
public void onNewToken(@NonNull String token) {
    Log.d(TAG, "Refreshed token: " + token);

    // If you want to send messages to this application instance or
    // manage this apps subscriptions on the server side, send the
    // FCM registration token to your app server.
    sendRegistrationToServer(token);
}
MyFirebaseMessagingService.java

टोकन मिलने के बाद, उसे अपने ऐप्लिकेशन सर्वर पर भेजा जा सकता है और अपने पसंदीदा तरीके का इस्तेमाल करके उसे सेव किया जा सकता है.

Google Play services की जांच करना

जो ऐप्लिकेशन Play सेवाओं के SDK टूल का इस्तेमाल करते हैं उन्हें Google Play services की सुविधाएं ऐक्सेस करने से पहले, हमेशा डिवाइस पर काम करने वाले Google Play services APK की जांच करनी चाहिए. हमारा सुझाव है कि ऐसा दो जगहों पर करें: मुख्य गतिविधि के onCreate() मेथड में और उसके onResume() मेथड में. onCreate() में की गई जांच से यह पक्का होता है कि जांच पूरी किए बिना, ऐप्लिकेशन का इस्तेमाल नहीं किया जा सकता. onResume() में चेक इन से यह पक्का होता है कि अगर उपयोगकर्ता किसी दूसरे तरीके, जैसे कि 'वापस जाएं' बटन से वापस चल रहे ऐप्लिकेशन पर वापस आता है, तब भी जांच की जा रही है.

अगर डिवाइस पर Google Play services का काम करने वाला वर्शन नहीं है, तो आपका ऐप्लिकेशन GoogleApiAvailability.makeGooglePlayServicesAvailable() को कॉल कर सकता है. इससे, उपयोगकर्ताओं को Play Store से Google Play services डाउनलोड करने की अनुमति मिलती है.

अपने-आप शुरू होने से रोकें

FCM रजिस्ट्रेशन टोकन जनरेट होने पर, लाइब्रेरी Firebase पर आइडेंटिफ़ायर और कॉन्फ़िगरेशन डेटा अपलोड करती है. अगर आपको टोकन अपने-आप जनरेट होने से रोकना है, तो Analytics कलेक्शन और FCM के अपने-आप शुरू होने की सुविधा बंद करें. इसके लिए, अपने AndroidManifest.xml में ये मेटाडेटा वैल्यू जोड़ें:

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />
AndroidManifest.xml

FCM के अपने-आप शुरू होने की सुविधा को फिर से चालू करने के लिए, रनटाइम कॉल करें:

Kotlin+KTX

Firebase.messaging.isAutoInitEnabled = true
MainActivity.kt

Java

FirebaseMessaging.getInstance().setAutoInitEnabled(true);
MainActivity.java

Analytics कलेक्शन को फिर से चालू करने के लिए, FirebaseAnalytics क्लास के setAnalyticsCollectionEnabled() तरीके को कॉल करें. उदाहरण के लिए:

setAnalyticsCollectionEnabled(true);

सेट होने के बाद, ये वैल्यू ऐप्लिकेशन के रीस्टार्ट होने पर भी बनी रहती हैं.

अगले चरण

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

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

ध्यान रखें कि इन सुविधाओं का फ़ायदा पाने के लिए, आपको सर्वर को लागू करना होगा और सर्वर प्रोटोकॉल (एचटीटीपी या XMPP) को लागू करना होगा या एडमिन SDK को लागू करना होगा.