FirebaseUI के साथ अपने Android ऐप में आसानी से साइन-इन जोड़ें

FirebaseUI , Firebase प्रमाणीकरण SDK के शीर्ष पर बनी एक लाइब्रेरी है जो आपके ऐप में उपयोग के लिए ड्रॉप-इन UI प्रवाह प्रदान करती है। FirebaseUI निम्नलिखित लाभ प्रदान करता है:

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

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

  1. यदि आपने पहले से नहीं किया है, तो अपने Android प्रोजेक्ट में Firebase जोड़ें

  2. FirebaseUI के लिए अपनी ऐप-लेवल build.gradle फ़ाइल में निर्भरताएँ जोड़ें। अगर आप फेसबुक या ट्विटर के साथ साइन-इन का समर्थन करना चाहते हैं, तो फेसबुक और ट्विटर एसडीके भी शामिल करें:

    dependencies {
        // ...
    
        implementation 'com.firebaseui:firebase-ui-auth:7.2.0'
    
        // Required only if Facebook login support is required
        // Find the latest Facebook SDK releases here: https://goo.gl/Ce5L94
        implementation 'com.facebook.android:facebook-android-sdk:8.x'
    }
    

    FirebaseUI प्रामाणिक SDK की Firebase SDK और Google Play सेवाओं के SDK पर सकर्मक निर्भरता है।

  3. फायरबेस कंसोल में, प्रमाणीकरण अनुभाग खोलें और उन साइन-इन विधियों को सक्षम करें जिनका आप समर्थन करना चाहते हैं। कुछ साइन-इन विधियों के लिए अतिरिक्त जानकारी की आवश्यकता होती है, जो आमतौर पर सेवा के डेवलपर कंसोल में उपलब्ध होती है।

  4. यदि आपने Google साइन-इन सक्षम किया है:

    1. कंसोल में संकेत दिए जाने पर, अपडेट की गई Firebase कॉन्फ़िगरेशन फ़ाइल ( google-services.json ) डाउनलोड करें, जिसमें अब Google साइन-इन के लिए आवश्यक OAuth क्लाइंट जानकारी शामिल है।

    2. इस अपडेट की गई कॉन्फ़िग फ़ाइल को अपने Android Studio प्रोजेक्ट में ले जाएँ, जो अब पुरानी संगत कॉन्फ़िग फ़ाइल को बदल रही है । ( अपने Android प्रोजेक्ट में Firebase जोड़ें देखें।)

    3. यदि आपने अभी तक अपने ऐप के SHA फ़िंगरप्रिंट को निर्दिष्ट नहीं किया है, तो Firebase कंसोल के सेटिंग पृष्ठ से ऐसा करें। अपने ऐप का SHA फ़िंगरप्रिंट कैसे प्राप्त करें, इसके विवरण के लिए अपने क्लाइंट का प्रमाणीकरण देखें।

  5. यदि आप Facebook या Twitter के साथ साइन-इन का समर्थन करते हैं, तो strings.xml में स्ट्रिंग संसाधन जोड़ें जो प्रत्येक प्रदाता द्वारा आवश्यक पहचान करने वाली जानकारी निर्दिष्ट करें:

    
    <resources>
      <!-- Facebook application ID and custom URL scheme (app ID prefixed by 'fb'). -->
      <string name="facebook_application_id" translatable="false">YOUR_APP_ID</string>
      <string name="facebook_login_protocol_scheme" translatable="false">fbYOUR_APP_ID</string>
    </resources>
    

दाखिल करना

एक ActivityResultLauncher बनाएँ जो FirebaseUI गतिविधि परिणाम अनुबंध के लिए कॉलबैक पंजीकृत करता है:

Kotlin+KTX

// See: https://developer.android.com/training/basics/intents/result
private val signInLauncher = registerForActivityResult(
    FirebaseAuthUIActivityResultContract(),
) { res ->
    this.onSignInResult(res)
}

Java

// See: https://developer.android.com/training/basics/intents/result
private final ActivityResultLauncher<Intent> signInLauncher = registerForActivityResult(
        new FirebaseAuthUIActivityResultContract(),
        new ActivityResultCallback<FirebaseAuthUIAuthenticationResult>() {
            @Override
            public void onActivityResult(FirebaseAuthUIAuthenticationResult result) {
                onSignInResult(result);
            }
        }
);

FirebaseUI साइन इन फ़्लो को शुरू करने के लिए, अपनी पसंदीदा साइन-इन विधियों के साथ एक साइन इन इंटेंट बनाएँ:

Kotlin+KTX

// Choose authentication providers
val providers = arrayListOf(
    AuthUI.IdpConfig.EmailBuilder().build(),
    AuthUI.IdpConfig.PhoneBuilder().build(),
    AuthUI.IdpConfig.GoogleBuilder().build(),
    AuthUI.IdpConfig.FacebookBuilder().build(),
    AuthUI.IdpConfig.TwitterBuilder().build(),
)

// Create and launch sign-in intent
val signInIntent = AuthUI.getInstance()
    .createSignInIntentBuilder()
    .setAvailableProviders(providers)
    .build()
signInLauncher.launch(signInIntent)

Java

// Choose authentication providers
List<AuthUI.IdpConfig> providers = Arrays.asList(
        new AuthUI.IdpConfig.EmailBuilder().build(),
        new AuthUI.IdpConfig.PhoneBuilder().build(),
        new AuthUI.IdpConfig.GoogleBuilder().build(),
        new AuthUI.IdpConfig.FacebookBuilder().build(),
        new AuthUI.IdpConfig.TwitterBuilder().build());

// Create and launch sign-in intent
Intent signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .build();
signInLauncher.launch(signInIntent);

जब साइन-इन प्रवाह पूर्ण हो जाता है, तो आपको परिणाम onSignInResult में प्राप्त होगा:

Kotlin+KTX

private fun onSignInResult(result: FirebaseAuthUIAuthenticationResult) {
    val response = result.idpResponse
    if (result.resultCode == RESULT_OK) {
        // Successfully signed in
        val user = FirebaseAuth.getInstance().currentUser
        // ...
    } else {
        // Sign in failed. If response is null the user canceled the
        // sign-in flow using the back button. Otherwise check
        // response.getError().getErrorCode() and handle the error.
        // ...
    }
}

Java

private void onSignInResult(FirebaseAuthUIAuthenticationResult result) {
    IdpResponse response = result.getIdpResponse();
    if (result.getResultCode() == RESULT_OK) {
        // Successfully signed in
        FirebaseUser user = FirebaseAuth.getInstance().getCurrentUser();
        // ...
    } else {
        // Sign in failed. If response is null the user canceled the
        // sign-in flow using the back button. Otherwise check
        // response.getError().getErrorCode() and handle the error.
        // ...
    }
}

साइन-इन विधियों को सेट करें

  1. फायरबेस कंसोल में, प्रमाणीकरण अनुभाग खोलें। साइन इन विधि टैब पर, ईमेल/पासवर्ड प्रदाता को सक्षम करें। ध्यान दें कि ईमेल लिंक साइन-इन का उपयोग करने के लिए ईमेल/पासवर्ड साइन-इन सक्षम होना चाहिए।

  2. उसी अनुभाग में, ईमेल लिंक (पासवर्ड रहित साइन-इन) साइन-इन विधि सक्षम करें और सहेजें पर क्लिक करें।

  3. आपको ईमेल-लिंक साइन इन का उपयोग करने के लिए फायरबेस डायनेमिक लिंक्स को भी सक्षम करना होगा। फायरबेस कंसोल में, नेविगेशन बार में एंगेज के तहत डायनेमिक लिंक्स पर क्लिक करें। आरंभ करना पर क्लिक करें और एक डोमेन जोड़ें। आपके द्वारा यहां चुना गया डोमेन आपके उपयोगकर्ताओं को भेजे गए ईमेल लिंक में दिखाई देगा।

  4. आप EmailBuilder उदाहरण पर enableEmailLinkSignIn को कॉल करके FirebaseUI में ईमेल लिंक साइन इन को सक्षम कर सकते हैं। आपको एक मान्य ActionCodeSettings ऑब्जेक्ट भी प्रदान करना होगा जिसमें setHandleCodeInApp को सही पर सेट किया गया हो। इसके अतिरिक्त, आपको उस URL को श्वेतसूची में डालना होगा जिसे आप setUrl को पास करते हैं, जो प्रमाणीकरण -> साइन इन विधियों -> अधिकृत डोमेन के अंतर्गत Firebase कंसोल में किया जा सकता है।

    Kotlin+KTX

    val actionCodeSettings = ActionCodeSettings.newBuilder()
        .setAndroidPackageName( // yourPackageName=
            "...", // installIfNotAvailable=
            true, // minimumVersion=
            null,
        )
        .setHandleCodeInApp(true) // This must be set to true
        .setUrl("https://google.com") // This URL needs to be whitelisted
        .build()
    
    val providers = listOf(
        EmailBuilder()
            .enableEmailLinkSignIn()
            .setActionCodeSettings(actionCodeSettings)
            .build(),
    )
    val signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .build()
    signInLauncher.launch(signInIntent)

    Java

    ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
            .setAndroidPackageName(
                    /* yourPackageName= */ "...",
                    /* installIfNotAvailable= */ true,
                    /* minimumVersion= */ null)
            .setHandleCodeInApp(true) // This must be set to true
            .setUrl("https://google.com") // This URL needs to be whitelisted
            .build();
    
    List<AuthUI.IdpConfig> providers = Arrays.asList(
            new AuthUI.IdpConfig.EmailBuilder()
                    .enableEmailLinkSignIn()
                    .setActionCodeSettings(actionCodeSettings)
                    .build()
    );
    Intent signInIntent = AuthUI.getInstance()
            .createSignInIntentBuilder()
            .setAvailableProviders(providers)
            .build();
    signInLauncher.launch(signInIntent);
  5. यदि आप किसी विशिष्ट गतिविधि में लिंक को पकड़ना चाहते हैं, तो कृपया यहां बताए गए चरणों का पालन करें। अन्यथा, लिंक आपकी लॉन्चर गतिविधि पर रीडायरेक्ट करेगा।

  6. एक बार जब आप डीप लिंक पकड़ लेते हैं, तो आपको यह सत्यापित करने के लिए कॉल करना होगा कि हम इसे आपके लिए संभाल सकते हैं। अगर हम कर सकते हैं, तो आपको इसे setEmailLink के माध्यम से हमें पास करना होगा।

    Kotlin+KTX

    if (AuthUI.canHandleIntent(intent)) {
        val extras = intent.extras ?: return
        val link = extras.getString("email_link_sign_in")
        if (link != null) {
            val signInIntent = AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setEmailLink(link)
                .setAvailableProviders(providers)
                .build()
            signInLauncher.launch(signInIntent)
        }
    }

    Java

    if (AuthUI.canHandleIntent(getIntent())) {
        if (getIntent().getExtras() == null) {
            return;
        }
        String link = getIntent().getExtras().getString("email_link_sign_in");
        if (link != null) {
            Intent signInIntent = AuthUI.getInstance()
                    .createSignInIntentBuilder()
                    .setEmailLink(link)
                    .setAvailableProviders(providers)
                    .build();
            signInLauncher.launch(signInIntent);
        }
    }
  7. वैकल्पिक क्रॉस डिवाइस ईमेल लिंक साइन इन समर्थित है, जिसका अर्थ है कि आपके Android ऐप के माध्यम से भेजे गए लिंक का उपयोग आपके वेब या Apple ऐप में लॉग इन करने के लिए किया जा सकता है। डिफ़ॉल्ट रूप से, क्रॉस डिवाइस समर्थन सक्षम है। आप EmailBuilder उदाहरण पर setForceSameDevice कॉल करके इसे अक्षम कर सकते हैं।

    अधिक जानकारी के लिए FirebaseUI-वेब और FirebaseUI-iOS देखें।

साइन आउट

FirebaseUI, Firebase प्रमाणीकरण के साथ-साथ सभी सामाजिक पहचान प्रदाताओं से साइन आउट करने के सुविधाजनक तरीके प्रदान करता है:

Kotlin+KTX

AuthUI.getInstance()
    .signOut(this)
    .addOnCompleteListener {
        // ...
    }

Java

AuthUI.getInstance()
        .signOut(this)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            public void onComplete(@NonNull Task<Void> task) {
                // ...
            }
        });

आप उपयोगकर्ता के खाते को पूरी तरह से हटा भी सकते हैं:

Kotlin+KTX

AuthUI.getInstance()
    .delete(this)
    .addOnCompleteListener {
        // ...
    }

Java

AuthUI.getInstance()
        .delete(this)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // ...
            }
        });

अनुकूलन

डिफ़ॉल्ट रूप से FirebaseUI थीमिंग के लिए AppCompat का उपयोग करता है, जिसका अर्थ है कि यह स्वाभाविक रूप से आपके ऐप की रंग योजना को अपनाएगा। यदि आपको और अनुकूलन की आवश्यकता है तो आप साइन-इन Intent बिल्डर को थीम और लोगो पास कर सकते हैं:

Kotlin+KTX

val signInIntent = AuthUI.getInstance()
    .createSignInIntentBuilder()
    .setAvailableProviders(providers)
    .setLogo(R.drawable.my_great_logo) // Set logo drawable
    .setTheme(R.style.MySuperAppTheme) // Set theme
    .build()
signInLauncher.launch(signInIntent)

Java

Intent signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .setLogo(R.drawable.my_great_logo)      // Set logo drawable
        .setTheme(R.style.MySuperAppTheme)      // Set theme
        .build();
signInLauncher.launch(signInIntent);

आप कस्टम गोपनीयता नीति और सेवा की शर्तें भी सेट कर सकते हैं:

Kotlin+KTX

val signInIntent = AuthUI.getInstance()
    .createSignInIntentBuilder()
    .setAvailableProviders(providers)
    .setTosAndPrivacyPolicyUrls(
        "https://example.com/terms.html",
        "https://example.com/privacy.html",
    )
    .build()
signInLauncher.launch(signInIntent)

Java

Intent signInIntent = AuthUI.getInstance()
        .createSignInIntentBuilder()
        .setAvailableProviders(providers)
        .setTosAndPrivacyPolicyUrls(
                "https://example.com/terms.html",
                "https://example.com/privacy.html")
        .build();
signInLauncher.launch(signInIntent);

अगले कदम

  • FirebaseUI का उपयोग करने और अनुकूलित करने के बारे में अधिक जानकारी के लिए, GitHub पर README फ़ाइल देखें।
  • अगर आपको FirebaseUI में कोई समस्या मिलती है और आप इसकी रिपोर्ट करना चाहते हैं, तो GitHub इश्यू ट्रैकर का उपयोग करें।