PhoneAuthProvider class

PhoneAuthCredential बनाने के लिए प्रदाता .

PhoneAuthProvider Node.js परिवेश में काम नहीं करता है।

हस्ताक्षर:

export declare class PhoneAuthProvider

कंस्ट्रक्टर्स

निर्माता संशोधक विवरण
(निर्माता)(लेखक) PhoneAuthProvider वर्ग का एक नया उदाहरण बनाता है

गुण

संपत्ति संशोधक प्रकार विवरण
PHONE_SIGN_IN_METHOD static 'फ़ोन' हमेशा साइनइनमेथड पर सेट करें ।फ़ोन।
प्रदाता_आईडी static 'फ़ोन' हमेशा प्रदाताआईडी पर सेट करें ।फ़ोन।
प्रदाताआईडी "फ़ोन" हमेशा प्रदाताआईडी पर सेट करें ।फ़ोन।

तरीकों

तरीका संशोधक विवरण
क्रेडेंशियल (सत्यापन आईडी, सत्यापन कोड) static PhoneAuthProvider.verifyPhoneNumber() से सत्यापन आईडी और उपयोगकर्ता के मोबाइल डिवाइस पर भेजे गए कोड को देखते हुए, एक फ़ोन प्रमाणीकरण क्रेडेंशियल बनाता है।
क्रेडेंशियलफ्रॉमएरर(त्रुटि) static कोई त्रुटि पारित होने पर एक प्रामाणिक क्रेडेंशियल लौटाता है।
credentialFromResult(userCredential) static उपयोगकर्ता क्रेडेंशियल से एक प्रामाणिक क्रेडेंशियल उत्पन्न करता है .
सत्यापितफ़ोननंबर(फ़ोनविकल्प, एप्लिकेशनसत्यापनकर्ता) दिए गए फ़ोन नंबर पर एक सत्यापन कोड भेजकर फ़ोन नंबर प्रमाणीकरण प्रवाह प्रारंभ करता है।

PhoneAuthProvider.(निर्माता)

PhoneAuthProvider वर्ग का एक नया उदाहरण बनाता है

हस्ताक्षर:

constructor(auth: Auth);

पैरामीटर

पैरामीटर प्रकार विवरण
प्रमाणन प्रमाणीकरण फायरबेस प्रामाणिक उदाहरण जिसमें साइन-इन होना चाहिए।

PhoneAuthProvider.PHONE_SIGN_IN_METHOD

हमेशा साइनइनमेथड पर सेट करें ।फ़ोन।

हस्ताक्षर:

static readonly PHONE_SIGN_IN_METHOD: 'phone';

PhoneAuthProvider.PROVIDER_ID

हमेशा प्रदाताआईडी पर सेट करें ।फ़ोन।

हस्ताक्षर:

static readonly PROVIDER_ID: 'phone';

PhoneAuthProvider.providerId

हमेशा प्रदाताआईडी पर सेट करें ।फ़ोन।

हस्ताक्षर:

readonly providerId: "phone";

PhoneAuthProvider.credential()

PhoneAuthProvider.verifyPhoneNumber() से सत्यापन आईडी और उपयोगकर्ता के मोबाइल डिवाइस पर भेजे गए कोड को देखते हुए, एक फ़ोन प्रमाणीकरण क्रेडेंशियल बनाता है।

हस्ताक्षर:

static credential(verificationId: string, verificationCode: string): PhoneAuthCredential;

पैरामीटर

पैरामीटर प्रकार विवरण
सत्यापनआईडी डोरी सत्यापन आईडी PhoneAuthProvider.verifyPhoneNumber() से वापस आ गई .
सत्यापन कोड डोरी सत्यापन कोड उपयोगकर्ता के मोबाइल डिवाइस पर भेजा गया।

रिटर्न:

फ़ोनप्रामाणिकक्रेडेंशियल

प्रमाणीकरण प्रदाता क्रेडेंशियल.

उदाहरण 1

const provider = new PhoneAuthProvider(auth);
const verificationId = provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = signInWithCredential(auth, authCredential);

उदाहरण 2

signInWithPhoneNumber विधि का उपयोग करके एक वैकल्पिक प्रवाह प्रदान किया जाता है।

const confirmationResult = await signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const userCredential = await confirmationResult.confirm(verificationCode);

PhoneAuthProvider.credentialFromError()

कोई त्रुटि पारित होने पर एक प्रामाणिक क्रेडेंशियल लौटाता है।

यह विधि auth/account-exists-with-different-credentials जैसी त्रुटियों के लिए काम करती है . यह उपयोगकर्ता का फ़ोन नंबर सेट करने का प्रयास करते समय पुनर्प्राप्त करने के लिए उपयोगी है, लेकिन विचाराधीन नंबर पहले से ही किसी अन्य खाते से जुड़ा हुआ है। उदाहरण के लिए, निम्न कोड वर्तमान उपयोगकर्ता के फ़ोन नंबर को अपडेट करने का प्रयास करता है, और यदि वह विफल रहता है, तो उपयोगकर्ता को उस नंबर से जुड़े खाते से लिंक करता है:

const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber(number, verifier);
try {
  const code = ''; // Prompt the user for the verification code
  await updatePhoneNumber(
      auth.currentUser,
      PhoneAuthProvider.credential(verificationId, code));
} catch (e) {
  if ((e as FirebaseError)?.code === 'auth/account-exists-with-different-credential') {
    const cred = PhoneAuthProvider.credentialFromError(e);
    await linkWithCredential(auth.currentUser, cred);
  }
}

// At this point, auth.currentUser.phoneNumber === number.

हस्ताक्षर:

static credentialFromError(error: FirebaseError): AuthCredential | null;

पैरामीटर

पैरामीटर प्रकार विवरण
गलती फायरबेसत्रुटि क्रेडेंशियल उत्पन्न करने में त्रुटि.

रिटर्न:

प्रामाणिक क्रेडेंशियल | व्यर्थ

PhoneAuthProvider.credentialFromResult()

उपयोगकर्ता क्रेडेंशियल से एक प्रामाणिक क्रेडेंशियल उत्पन्न करता है .

हस्ताक्षर:

static credentialFromResult(userCredential: UserCredential): AuthCredential | null;

पैरामीटर

पैरामीटर प्रकार विवरण
उपयोगकर्ता क्रेडेंशियल उपयोगकर्ता क्रेडेंशियल उपयोगकर्ता क्रेडेंशियल.

रिटर्न:

प्रामाणिक क्रेडेंशियल | व्यर्थ

PhoneAuthProvider.verifyPhoneNumber()

दिए गए फ़ोन नंबर पर एक सत्यापन कोड भेजकर फ़ोन नंबर प्रमाणीकरण प्रवाह प्रारंभ करता है।

हस्ताक्षर:

verifyPhoneNumber(phoneOptions: PhoneInfoOptions | string, applicationVerifier: ApplicationVerifier): Promise<string>;

पैरामीटर

पैरामीटर प्रकार विवरण
फ़ोनविकल्प फ़ोनइन्फोऑप्शंस | डोरी
एप्लिकेशनसत्यापनकर्ता अनुप्रयोगसत्यापनकर्ता दुरुपयोग की रोकथाम के लिए, इस विधि के लिए एक एप्लिकेशन सत्यापनकर्ता की भी आवश्यकता होती है . इस SDK में एक reCAPTCHA-आधारित कार्यान्वयन, RecaptchaVerifier शामिल है .

रिटर्न:

वादा<स्ट्रिंग>

एक सत्यापन आईडी के लिए एक वादा जिसे इस प्रवाह की पहचान करने के लिए PhoneAuthProvider.credential() को पास किया जा सकता है।

उदाहरण 1

const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber(phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const authCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = await signInWithCredential(auth, authCredential);

उदाहरण 2

signInWithPhoneNumber विधि का उपयोग करके एक वैकल्पिक प्रवाह प्रदान किया जाता है।

const confirmationResult = signInWithPhoneNumber(auth, phoneNumber, applicationVerifier);
// Obtain verificationCode from the user.
const userCredential = confirmationResult.confirm(verificationCode);

उदाहरण

// 'recaptcha-container' is the ID of an element in the DOM.
const applicationVerifier = new RecaptchaVerifier('recaptcha-container');
const provider = new PhoneAuthProvider(auth);
const verificationId = await provider.verifyPhoneNumber('+16505550101', applicationVerifier);
// Obtain the verificationCode from the user.
const phoneCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
const userCredential = await signInWithCredential(auth, phoneCredential);