رسیدگی به خطاهای «درستی‌سنجی شماره تلفن Firebase» در Android

وقتی تماس با کتابخانه Firebase PNV ناموفق باشد، کتابخانه FirebasePhoneNumberVerificationException را گزارش می‌کند. این صفحه همه کدهای خطایی را که استثنا می‌تواند داشته باشد، زمان وقوع هرکدام، و کاری را که برنامه شما باید درقبال آن انجام دهد فهرست می‌کند.

این صفحه فرض می‌کند که شما Firebase PNV را همان‌طور که در شروع به کار با Firebase Phone Number Verification در Android شرح داده شده است ادغام کرده‌اید.

نحوه گزارش شدن خطاها

• روش‌های ناهمگام (getVerificationSupportInfo()، getVerifiedPhoneNumber()، و روش‌های جریان سفارشی) Task را برمی‌گردانند. وقتی این بررسی‌ها ناموفق باشد، Task با FirebasePhoneNumberVerificationException ناموفق می‌شود که آن را در addOnFailureListener دریافت می‌کنید.

• enableTestSession() همگام است. مستقیماً FirebasePhoneNumberVerificationException پرتاب می‌کند.

برای اینکه متوجه شوید مشکل چیست، errorCode استثنا را بخوانید. کدهای Firebase PNV ثابت‌هایی در کلاس FirebasePnvStatusCodes هستند. اگر خطا از «خدمات Google Play» باشد، errorCode می‌تواند مقدار CommonStatusCodes نیز باشد، مثل NETWORK_ERROR.

دستگاه یا سیم‌کارت پشتیبانی‌نشده خطا محسوب نمی‌شود. getVerificationSupportInfo() موفق می‌شود و isSupported() را به‌عنوان false برای آن سیم‌کارت گزارش می‌کند، و getReason() دلیل آن را به شما می‌گوید. دستگاه‌ها و سیم‌کارت‌های پشتیبانی‌نشده را ببینید.

کدهای خطا

راه‌اندازی جلسه آزمایشی

این خطاها به‌صورت هم‌زمان توسط enableTestSession() ایجاد می‌شوند.

درستی‌سنجی

این خطاها باعث رد شدن Task برگردانده‌شده توسط getVerifiedPhoneNumber() می‌شود.

بررسی پشتیبانی

Task برگردانده‌شده توسط getVerificationSupportInfo() فقط درصورتی ناموفق است که خود بررسی نتواند اجرا شود. در این حالت، errorCode یا مقدار «خدمات Google Play» است CommonStatusCodes یا CARRIER_NOT_SUPPORTED. دستگاه را به‌عنوان دستگاه پشتیبانی‌نشده درنظر بگیرید و به روش درستی‌سنجی دیگری، مثل پیامک، برگردید.

وقتی جلسه آزمایشی فعال است، getVerificationSupportInfo() با بخش پشتی Firebase PNV تماس نمی‌گیرد و همیشه سیم‌کارت آزمایشی را به‌عنوان پشتیبانی‌شده گزارش می‌کند، حتی اگر ژتون آزمایشی منقضی شده باشد.

جریان سفارشی

اگر به‌جای getVerifiedPhoneNumber() از جریان سفارشی استفاده می‌کنید:

• getDigitalCredentialPayload() با PREFLIGHT_CHECK_FAILED ناموفق می‌شود، یا با INVALID_TEST_NUMBER_ID اگر باطن کد آزمایشی شما را رد کند.
• exchangeCredentialResponseForPhoneNumber() با INVALID_DIGITAL_CREDENTIAL_RESPONSE یا با INVALID_TEST_NUMBER_ID ناموفق می‌شود اگر بخش باطنی کد آزمایشی شما را رد کند.
• فراخوانی شما به Credential Manager یک GetCredentialException را برمی‌گرداند که شما مستقیماً آن را مدیریت می‌کنید.

دستگاه‌ها و سیم‌کارت‌های پشتیبانی‌نشده

وقتی isSupported() برای سیم‌کارت false باشد، getReason() یکی از مقادیر زیر VerificationSupportStatus را برمی‌گرداند:

در هر مورد، از روش درستی‌سنجی دیگری، مثل پیامک، برای آن سیم‌کارت استفاده کنید.

مثال

مثال زیر خطاهایی را که یک برنامه معمولی باید هنگام فراخوانی getVerifiedPhoneNumber() تشخیص دهد، مدیریت می‌کند:

import android.util.Log
// Credential Manager is included with the Firebase PNV library.
import androidx.credentials.exceptions.GetCredentialCancellationException
import com.google.firebase.pnv.FirebasePhoneNumberVerification
import com.google.firebase.pnv.FirebasePhoneNumberVerificationException
import com.google.firebase.pnv.FirebasePnvStatusCodes

private const val TAG = "PhoneVerification"

// In your Activity:
private fun verifyPhoneNumber() {
    FirebasePhoneNumberVerification.getInstance()
        .getVerifiedPhoneNumber(this)
        .addOnSuccessListener { result ->
            // Send result.getToken() to your backend.
        }
        .addOnFailureListener { e -> handleFpnvError(e) }
}

private fun handleFpnvError(e: Exception) {
    if (e !is FirebasePhoneNumberVerificationException) {
        Log.w(TAG, "Firebase PNV failed", e)
        showSmsVerification()
        return
    }
    when (e.errorCode) {
        FirebasePnvStatusCodes.CREDENTIAL_MANAGER_ERROR -> {
            if (e.cause is GetCredentialCancellationException) {
                // The user dismissed the consent screen.
            }
            showSmsVerification()
        }
        FirebasePnvStatusCodes.INVALID_TEST_NUMBER_ID -> {
            // Test mode only: generate a new test token.
            Log.e(TAG, "Firebase PNV test token rejected", e)
        }
        FirebasePnvStatusCodes.ACTIVITY_CONTEXT_REQUIRED -> {
            // App bug: pass an Activity to getVerifiedPhoneNumber().
            Log.e(TAG, "Firebase PNV needs an Activity context", e)
        }
        else -> {
            // Carrier not supported, network errors, and other failures.
            Log.w(TAG, "Firebase PNV failed with error code ${e.errorCode}", e)
            showSmsVerification()
        }
    }
}

در این مثال، showSmsVerification() جریان درستی‌سنجی شماره تلفن موجود در برنامه‌تان است.

مراحل بعدی

• برای جزئیات مربوط به هر کلاس و ثابت، Firebase PNV مرجع میانای برنامه‌سازی کاربردی را ببینید.
• برای درستی‌سنجی کردن کد در سرور، به درستی‌سنجی کردن کدهای Firebase PNV مراجعه کنید.