FirebaseUI का इस्तेमाल करके, अपने वेब ऐप्लिकेशन में आसानी से साइन इन करने की सुविधा जोड़ें

FirebaseUI एक लाइब्रेरी है जो यह 'Firebase ऑथेंटिकेशन SDK' टूल का सबसे ऊपर वाला हिस्सा है. यह एपीआई इस्तेमाल करने के लिए ड्रॉप-इन यूआई फ़्लो उपलब्ध कराता है आपका ऐप्लिकेशन. FirebaseUI से ये फ़ायदे मिलते हैं:

  • एक से ज़्यादा सेवा देने वाली कंपनियां - ईमेल/पासवर्ड, ईमेल लिंक, फ़ोन के लिए साइन-इन फ़्लो की पुष्टि करें, Google, Facebook, Twitter, और GitHub में साइन इन करें.
  • खाता लिंक करना - पहचान की पुष्टि के लिए उपयोगकर्ता खातों को सुरक्षित तरीके से लिंक करने का फ़्लो सेवा देने वाली कंपनियां.
  • पसंद के मुताबिक बनाएं - अपने ऐप्लिकेशन से मैच करने के लिए, FirebaseUI की सीएसएस स्टाइल बदलें ज़रूरतें. साथ ही, FirebaseUI ओपन सोर्स होने की वजह से में अपने हिसाब से बदलाव कर सकता है.
  • एक-टैप साइन-अप और अपने आप साइन-इन - एक टैप में साइन-अप करें का इस्तेमाल करें.
  • स्थानीय भाषा में यूज़र इंटरफ़ेस (यूआई) - 40 से ज़्यादा उपयोगकर्ताओं के लिए अंतरराष्ट्रीय स्तर का languages.
  • पहचान छिपाने वाले उपयोगकर्ताओं को अपग्रेड करना - पहचान छिपाकर 'शोकेस' का इस्तेमाल करने वाले उपयोगकर्ताओं को अपग्रेड करने की सुविधा साइन-इन/साइन-अप करें. अधिक जानकारी के लिए, अज्ञात उपयोगकर्ताओं को अपग्रेड करना सेक्शन में दिया गया है.

शुरू करने से पहले

  1. अपने वेब ऐप्लिकेशन में Firebase से पुष्टि करने की सुविधा जोड़ें, पक्का करें कि v9 कॉम्पैट (सुझाया गया) या पुराने SDK टूल का इस्तेमाल किया जा रहा है (देखें साइडबार देखें).

  2. नीचे दिए गए विकल्पों में से किसी एक का इस्तेमाल करके, FirebaseUI शामिल करें:

    1. सीडीएन

      <head> में यह स्क्रिप्ट और सीएसएस फ़ाइल शामिल करें का टैग अपने पेज पर, Firebase कंसोल से इनिशलाइज़ेशन स्निपेट के नीचे:

      <script src="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.js"></script>
<link type="text/css" rel="stylesheet" href="https://www.gstatic.com/firebasejs/ui/6.0.1/firebase-ui-auth.css" />

    2. npm मॉड्यूल

      इनका इस्तेमाल करके, एनपीएम के ज़रिए FirebaseUI और इसकी डिपेंडेंसी को इंस्टॉल करें आदेश:

      $ npm install firebaseui --save

      आपकी सोर्स फ़ाइलों में ये मॉड्यूल require करें:

      var firebase = require('firebase');
var firebaseui = require('firebaseui');

    3. बोवर कॉम्पोनेंट

      इनका इस्तेमाल करके, Bower के ज़रिए FirebaseUI और इसकी डिपेंडेंसी को इंस्टॉल करें आदेश:

      $ bower install firebaseui --save

      अगर आपका एचटीटीपी सर्वर bower_components/ में मौजूद फ़ाइलें:

      <script src="bower_components/firebaseui/dist/firebaseui.js"></script>
<link type="text/css" rel="stylesheet" href="bower_components/firebaseui/dist/firebaseui.css" />

FirebaseUI शुरू करें

SDK टूल इंपोर्ट करने के बाद, अनुमति देने वाले यूज़र इंटरफ़ेस (यूआई) की शुरुआत करें.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

साइन-इन करने के तरीके सेट अप करना

उपयोगकर्ताओं को साइन इन करने के लिए Firebase का इस्तेमाल करने से पहले, आपको साइन-इन करने के ऐसे तरीके जिन्हें इस्तेमाल करने का विकल्प आपके पास है.

ईमेल पता और पासवर्ड

  1. Firebase console में, पुष्टि करने की सुविधा सेक्शन खोलें और ईमेल और पासवर्ड की पुष्टि की जाती है.

  2. FirebaseUI signInOptions की सूची में ईमेल की सेवा देने वाली कंपनी का आईडी जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.EmailAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  3. ज़रूरी नहीं: EmailAuthProvider को इस तरह कॉन्फ़िगर किया जा सकता है कि उपयोगकर्ता के लिए ज़रूरी हो डिसप्ले नाम डालने के लिए (डिफ़ॉल्ट रूप से यह true पर सेट होता है).

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      requireDisplayName: false
    }
  ]
});

  1. Firebase कंसोल में, पुष्टि करना सेक्शन खोलें. इस साइन इन करने का तरीका टैब में, ईमेल/पासवर्ड की सेवा देने वाली कंपनी को चालू करें. नोट जोड़ें ईमेल लिंक से साइन इन करने के लिए, यह ज़रूरी है कि ईमेल/पासवर्ड से साइन-इन करने की सुविधा चालू हो.

  2. इसी सेक्शन में, ईमेल लिंक (बिना पासवर्ड के साइन इन) से साइन-इन करने की सुविधा चालू करें तरीका और सेव करें पर क्लिक करें.

  3. FirebaseUI signInOptions की सूची में ईमेल प्रोवाइडर का आईडी जोड़ें ऐसा करने के लिए, signInMethod ईमेल लिंक का इस्तेमाल करें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD
    }
  ],
  // Other config options...
});

  4. साइन-इन यूज़र इंटरफ़ेस (यूआई) को किसी शर्त के साथ रेंडर करते समय (एक पेज वाले ऐप्लिकेशन के लिए प्रासंगिक) ui.isPendingRedirect() का इस्तेमाल करके पता लगाएं कि यूआरएल, साइन इन पेज से जुड़ा है या नहीं वाले ईमेल लिंक और यूज़र इंटरफ़ेस (यूआई) को रेंडर करने की ज़रूरत होती है, ताकि साइन-इन किया जा सके.

    // Is there an email link sign-in?
if (ui.isPendingRedirect()) {
  ui.start('#firebaseui-auth-container', uiConfig);
}
// This can also be done via:
if (firebase.auth().isSignInWithEmailLink(window.location.href)) {
  ui.start('#firebaseui-auth-container', uiConfig);
}

  5. ज़रूरी नहीं: ईमेल लिंक से साइन-इन करने के लिए, EmailAuthProvider उपयोगकर्ता को क्रॉस डिवाइस साइन-इन पूरा करने की अनुमति देने या ब्लॉक करने के लिए कॉन्फ़िगर किया गया है.

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

    FirebaseUI-वेब में ईमेल लिंक से साइन-इन करने की सुविधा इनके साथ काम करती है FirebaseUI-Android और FirebaseUI-iOS जहां FirebaseUI-Android से फ़्लो शुरू करने वाला उपयोगकर्ता, लिंक को खोल सकता है और FirebaseUI-web से साइन इन की प्रक्रिया पूरी करें. विपरीत स्थिति पर भी यही बात लागू होती है फ़्लो.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.EmailAuthProvider.PROVIDER_ID,
      signInMethod: firebase.auth.EmailAuthProvider.EMAIL_LINK_SIGN_IN_METHOD,
      // Allow the user the ability to complete sign-in cross device,
      // including the mobile apps specified in the ActionCodeSettings
      // object below.
      forceSameDevice: false,
      // Used to define the optional firebase.auth.ActionCodeSettings if
      // additional state needs to be passed along request and whether to open
      // the link in a mobile app if it is installed.
      emailLinkSignIn: function() {
        return {
          // Additional state showPromo=1234 can be retrieved from URL on
          // sign-in completion in signInSuccess callback by checking
          // window.location.href.
          url: 'https://www.example.com/completeSignIn?showPromo=1234',
          // Custom FDL domain.
          dynamicLinkDomain: 'example.page.link',
          // Always true for email link sign-in.
          handleCodeInApp: true,
          // Whether to handle link in iOS app if installed.
          iOS: {
            bundleId: 'com.example.ios'
          },
          // Whether to handle link in Android app if opened in an Android
          // device.
          android: {
            packageName: 'com.example.android',
            installApp: true,
            minimumVersion: '12'
          }
        };
      }
    }
  ]
});

OAuth की सेवा देने वाली कंपनियां (Google, Facebook, Twitter, और GitHub)

  1. Firebase console में, पुष्टि करने की सुविधा सेक्शन खोलें और OAuth प्रोवाइडर साइन इन करें. पक्का करें कि संबंधित OAuth क्लाइंट आईडी और सीक्रेट भी बताया गया है.

  2. साथ ही, पुष्टि करें सेक्शन में जाकर पक्का करें कि वह डोमेन साइन-इन पेज को अनुमति वाले डोमेन की सूची में भी जोड़ दिया जाएगा.

  3. FirebaseUI signInOptions की सूची में OAuth प्रोवाइडर का आईडी जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    // List of OAuth providers supported.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. ज़रूरी नहीं: कस्टम स्कोप या कस्टम OAuth पैरामीटर की संख्या तय करने के लिए प्रोवाइडर के पास है, तो आप सिर्फ़ प्रोवाइडर वैल्यू के बजाय एक ऑब्जेक्ट पास कर सकते हैं:

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.GoogleAuthProvider.PROVIDER_ID,
      scopes: [
        'https://www.googleapis.com/auth/contacts.readonly'
      ],
      customParameters: {
        // Forces account selection even when one account
        // is available.
        prompt: 'select_account'
      }
    },
    {
      provider: firebase.auth.FacebookAuthProvider.PROVIDER_ID,
      scopes: [
        'public_profile',
        'email',
        'user_likes',
        'user_friends'
      ],
      customParameters: {
        // Forces password re-entry.
        auth_type: 'reauthenticate'
      }
    },
    firebase.auth.TwitterAuthProvider.PROVIDER_ID, // Twitter does not support scopes.
    firebase.auth.EmailAuthProvider.PROVIDER_ID // Other providers don't need to be given as object.
  ]
});

फ़ोन नंबर

  1. Firebase console में, पुष्टि करने की सुविधा सेक्शन खोलें और फ़ोन नंबर से साइन-इन करें.

  2. पक्का करें कि जिस डोमेन में आपका साइन-इन पेज रेंडर किया जाएगा को अनुमति मिली हुई डोमेन सूची में जोड़ा गया.

  3. FirebaseUI signInOptions की सूची में फ़ोन नंबर देने वाली कंपनी का आईडी जोड़ें.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Other config options...
});

  4. ज़रूरी नहीं: PhoneAuthProvider को कस्टम reCAPTCHA के साथ कॉन्फ़िगर किया जा सकता है यह पैरामीटर दिखाता है कि reCAPTCHA दिख रहा है या नहीं. यह डिफ़ॉल्ट रूप से सामान्य पर सेट होता है. देखें re कैप्चा API दस्तावेज़ देखें.

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

    फ़िलहाल, ये विकल्प इस्तेमाल किए जा सकते हैं.

    ui.start('#firebaseui-auth-container', {
  signInOptions: [
    {
      provider: firebase.auth.PhoneAuthProvider.PROVIDER_ID,
      recaptchaParameters: {
        type: 'image', // 'audio'
        size: 'normal', // 'invisible' or 'compact'
        badge: 'bottomleft' //' bottomright' or 'inline' applies to invisible.
      },
      defaultCountry: 'GB', // Set default country to the United Kingdom ( 44).
      // For prefilling the national number, set defaultNationNumber.
      // This will only be observed if only phone Auth provider is used since
      // for multiple providers, the NASCAR screen will always render first
      // with a 'sign in with phone number' button.
      defaultNationalNumber: '1234567890',
      // You can also pass the full phone number string instead of the
      // 'defaultCountry' and 'defaultNationalNumber'. However, in this case,
      // the first country ID that matches the country code will be used to
      // populate the country selector. So for countries that share the same
      // country code, the selected country may not be the expected one.
      // In that case, pass the 'defaultCountry' instead to ensure the exact
      // country is selected. The 'defaultCountry' and 'defaultNationaNumber'
      // will always have higher priority than 'loginHint' which will be ignored
      // in their favor. In this case, the default country will be 'GB' even
      // though 'loginHint' specified the country code as ' 1'.
      loginHint: ' 11234567890'
    }
  ]
});

साइन इन करें

FirebaseUI साइन इन फ़्लो को शुरू करने के लिए, FirebaseUI इंस्टेंस को इस तरह शुरू करें मौजूदा Auth इंस्टेंस को पास करना.

// Initialize the FirebaseUI Widget using Firebase.
var ui = new firebaseui.auth.AuthUI(firebase.auth());

वह एचटीएमएल एलिमेंट तय करें जिसमें FirebaseUI साइन इन विजेट रेंडर किया जाएगा.

<!-- The surrounding HTML is left untouched by FirebaseUI.
     Your app may use that space for branding, controls and other customizations.-->
<h1>Welcome to My Awesome App</h1>
<div id="firebaseui-auth-container"></div>
<div id="loader">Loading...</div>

FirebaseUI कॉन्फ़िगरेशन (providers काम करता है और यूज़र इंटरफ़ेस (यूआई) कस्टमाइज़ेशन) तय करें साथ ही, सही कॉलबैक वगैरह).

var uiConfig = {
  callbacks: {
    signInSuccessWithAuthResult: function(authResult, redirectUrl) {
      // User successfully signed in.
      // Return type determines whether we continue the redirect automatically
      // or whether we leave that to developer to handle.
      return true;
    },
    uiShown: function() {
      // The widget is rendered.
      // Hide the loader.
      document.getElementById('loader').style.display = 'none';
    }
  },
  // Will use popup for IDP Providers sign-in flow instead of the default, redirect.
  signInFlow: 'popup',
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    // Leave the lines as is for the providers you want to offer your users.
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.TwitterAuthProvider.PROVIDER_ID,
    firebase.auth.GithubAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  // Terms of service url.
  tosUrl: '<your-tos-url>',
  // Privacy policy url.
  privacyPolicyUrl: '<your-privacy-policy-url>'
};

आखिर में, FirebaseUI पुष्टि वाले इंटरफ़ेस को रेंडर करें:

// The start method will wait until the DOM is loaded.
ui.start('#firebaseui-auth-container', uiConfig);

पहचान छिपाने वाले उपयोगकर्ताओं को अपग्रेड करना

पहचान छिपाकर 'उपयोगकर्ता अपग्रेड' चालू किया जा रहा है

जब कोई अनाम उपयोगकर्ता साइन इन करता है या स्थायी खाते से साइन अप करता है, तो आपको ताकि यह पक्का हो सके कि साइन अप करने से पहले उपयोगकर्ता अपने काम को जारी रख सके. ऐसा करने के लिए, कॉन्फ़िगर करते समय autoUpgradeAnonymousUsers को true पर सेट करें साइन-इन यूज़र इंटरफ़ेस (यूआई) (यह विकल्प डिफ़ॉल्ट रूप से बंद होता है).

पहचान छिपाकर 'उपयोगकर्ता अपग्रेड' को मर्ज करने से जुड़ी समस्याओं को मैनेज करना

ऐसा भी हो सकता है कि कोई उपयोगकर्ता शुरुआती तौर पर, पहचान छिपाकर साइन इन करने के बाद अपग्रेड करने की कोशिश करे का इस्तेमाल करने वाले उपयोगकर्ताओं की संख्या बढ़ाई जा सकती है. चूंकि एक मौजूदा उपयोगकर्ता को किसी दूसरे उपयोगकर्ता से लिंक नहीं किया जा सकता है तो FirebaseUI signInFailure कॉलबैक को इस गड़बड़ी कोड firebaseui/anonymous-upgrade-merge-conflict जब ऊपर होता है. गड़बड़ी वाले ऑब्जेक्ट में स्थायी क्रेडेंशियल भी शामिल होगा. इससे साइन-इन करें: साइन-इन पूरा करने के लिए, स्थायी क्रेडेंशियल को कॉलबैक में ट्रिगर होना चाहिए. इसके ज़रिए साइन-इन पूर्ण करने से पहले auth.signInWithCredential(error.credential), आपको अपनी पहचान छिपाकर लिखी गई चैट को सेव करना होगा उस उपयोगकर्ता के डेटा को मिटाया जा सकता है. फिर, साइन-इन पूरा होने के बाद, कॉपी करें बिना पहचान वाले उपयोगकर्ता के डेटा पर वापस चला जाता है. नीचे दिए गए उदाहरण में बताया गया है कि नया फ़्लो सही तरीके से काम करेगा.

// Temp variable to hold the anonymous user data if needed.
var data = null;
// Hold a reference to the anonymous current user.
var anonymousUser = firebase.auth().currentUser;
ui.start('#firebaseui-auth-container', {
  // Whether to upgrade anonymous users should be explicitly provided.
  // The user must already be signed in anonymously before FirebaseUI is
  // rendered.
  autoUpgradeAnonymousUsers: true,
  signInSuccessUrl: '<url-to-redirect-to-on-success>',
  signInOptions: [
    firebase.auth.GoogleAuthProvider.PROVIDER_ID,
    firebase.auth.FacebookAuthProvider.PROVIDER_ID,
    firebase.auth.EmailAuthProvider.PROVIDER_ID,
    firebase.auth.PhoneAuthProvider.PROVIDER_ID
  ],
  callbacks: {
    // signInFailure callback must be provided to handle merge conflicts which
    // occur when an existing credential is linked to an anonymous user.
    signInFailure: function(error) {
      // For merge conflicts, the error.code will be
      // 'firebaseui/anonymous-upgrade-merge-conflict'.
      if (error.code != 'firebaseui/anonymous-upgrade-merge-conflict') {
        return Promise.resolve();
      }
      // The credential the user tried to sign in with.
      var cred = error.credential;
      // Copy data from anonymous user to permanent user and delete anonymous
      // user.
      // ...
      // Finish sign-in after data is copied.
      return firebase.auth().signInWithCredential(cred);
    }
  }
});

अगले चरण