JavaScript क्लाइंट में मैसेज पाएं

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

ऐप्लिकेशन की स्थिति	सूचना	डेटा	दोनों
फ़ोरग्राउंड	`onMessage`	`onMessage`	`onMessage`
बैकग्राउंड (सर्विस वर्कर)	`onBackgroundMessage` (डिसप्ले की सूचना अपने-आप दिखने लगेगी)	`onBackgroundMessage`	`onBackgroundMessage` (डिसप्ले की सूचना अपने-आप दिखने लगेगी)

JavaScript का क्विकस्टार्ट सैंपल, मैसेज पाने के लिए ज़रूरी सभी कोड के बारे में बताता है.

वेब ऐप्लिकेशन के फ़ोरग्राउंड में होने पर मैसेज मैनेज करना

onMessage इवेंट पाने के लिए, आपके ऐप्लिकेशन को firebase-messaging-sw.js में Firebase मैसेज सर्विस वर्कर तय करना होगा. इसके अलावा, getToken(): Promise<string> की मदद से SDK टूल के लिए, कोई मौजूदा सर्विस वर्कर जोड़ा जा सकता है.

Web

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging/sw";

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
const firebaseApp = initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = getMessaging(firebaseApp);messaging_init_in_sw.js

Web

// Give the service worker access to Firebase Messaging.
// Note that you can only use Firebase Messaging here. Other Firebase libraries
// are not available in the service worker.
importScripts('https://www.gstatic.com/firebasejs/8.10.1/firebase-app.js');
importScripts('https://www.gstatic.com/firebasejs/8.10.1/firebase-messaging.js');

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
firebase.initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = firebase.messaging();service-worker.js

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

Web

// Handle incoming messages. Called when:
// - a message is received while the app has focus
// - the user clicks on an app notification created by a service worker
//   `messaging.onBackgroundMessage` handler.
import { getMessaging, onMessage } from "firebase/messaging";

const messaging = getMessaging();
onMessage(messaging, (payload) => {
  console.log('Message received. ', payload);
  // ...
});messaging_receive_message.js

Web

// Handle incoming messages. Called when:
// - a message is received while the app has focus
// - the user clicks on an app notification created by a service worker
//   `messaging.onBackgroundMessage` handler.
messaging.onMessage((payload) => {
  console.log('Message received. ', payload);
  // ...
});index.js

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

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

भेजने के अनुरोध में सूचना के विकल्प सेट करना

ऐप्लिकेशन सर्वर से भेजे जाने वाले सूचना मैसेज के लिए, FCM JavaScript API fcm_options.link कुंजी का इस्तेमाल करता है. आम तौर पर, यह आपके वेब ऐप्लिकेशन के किसी पेज पर सेट होता है:

https://fcm.googleapis.com//v1/projects/<YOUR-PROJECT-ID>/messages:send
Content-Type: application/json
Authorization: bearer <YOUR-ACCESS-TOKEN>

{
  "message": {
    "token": "eEz-Q2sG8nQ:APA91bHJQRT0JJ...",
    "notification": {
      "title": "Background Message Title",
      "body": "Background message body"
    },
    "webpush": {
      "fcm_options": {
        "link": "https://dummypage.com"
      }
    }
  }
}

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

डेटा मैसेज में fcm_options.link काम नहीं करता. इसलिए, आपको सभी डेटा मैसेज में सूचना पेलोड जोड़ने का सुझाव दिया जाता है. इसके अलावा, सर्विस वर्कर का इस्तेमाल करके सूचनाएं मैनेज की जा सकती हैं.

सूचना और डेटा मैसेज के बीच का अंतर जानने के लिए, मैसेज के टाइप देखें.

सर्विस वर्कर में सूचना विकल्प सेट करना

डेटा मैसेज के लिए, सर्विस वर्कर में सूचना के विकल्प सेट किए जा सकते हैं. सबसे पहले, सर्विस वर्कर में अपना ऐप्लिकेशन शुरू करें:

Web

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging/sw";

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
const firebaseApp = initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = getMessaging(firebaseApp);messaging_init_in_sw.js

Web

// Give the service worker access to Firebase Messaging.
// Note that you can only use Firebase Messaging here. Other Firebase libraries
// are not available in the service worker.
importScripts('https://www.gstatic.com/firebasejs/8.10.1/firebase-app.js');
importScripts('https://www.gstatic.com/firebasejs/8.10.1/firebase-messaging.js');

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
firebase.initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = firebase.messaging();service-worker.js

विकल्प सेट करने के लिए, firebase-messaging-sw.js में onBackgroundMessage पर कॉल करें. इस उदाहरण में, हमने टाइटल, मुख्य हिस्से, और आइकॉन फ़ील्ड के साथ सूचना बनाई है.

Web

import { getMessaging } from "firebase/messaging/sw";
import { onBackgroundMessage } from "firebase/messaging/sw";

const messaging = getMessaging();
onBackgroundMessage(messaging, (payload) => {
  console.log('[firebase-messaging-sw.js] Received background message ', payload);
  // Customize notification here
  const notificationTitle = 'Background Message Title';
  const notificationOptions = {
    body: 'Background Message body.',
    icon: '/firebase-logo.png'
  };

  self.registration.showNotification(notificationTitle,
    notificationOptions);
});messaging_on_background_message.js

Web

messaging.onBackgroundMessage((payload) => {
  console.log(
    '[firebase-messaging-sw.js] Received background message ',
    payload
  );
  // Customize notification here
  const notificationTitle = 'Background Message Title';
  const notificationOptions = {
    body: 'Background Message body.',
    icon: '/firebase-logo.png'
  };

  self.registration.showNotification(notificationTitle, notificationOptions);
});service-worker.js

सूचनाओं के लिए सबसे सही तरीके

अगर आपको वेब के लिए पुश मैसेज सेवा के बारे में पता है, तो हो सकता है कि आपने अच्छी सूचना बनाने के तरीकों से जुड़े बड़े दिशा-निर्देश पहले ही पढ़ लिए हों. 'वेब के लिए FCM' से सूचनाएं भेजने वाले डेवलपर के लिए, सबसे ज़्यादा ज़रूरी यह होना ज़रूरी है कि वे सटीक हों और उनके काम के हों. सूचनाओं को सटीक और काम का बनाए रखने के लिए, यहां कुछ खास सुझाव दिए गए हैं:

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