firebase-pnv/com.google.firebase.pnv

Package-level declarations

Types

actual interface FirebasePhoneNumberVerification

Firebase Phone Number Verification, mirroring com.google.firebase.pnv.FirebasePhoneNumberVerification from the Firebase Android SDK (com.google.firebase:firebase-pnv): gets the phone number of a SIM in the device directly from its carrier, with a token signed by Firebase for your backend to verify, instead of sending an SMS code.

actual interface FirebasePhoneNumberVerification

expect interface FirebasePhoneNumberVerification

actual interface FirebasePhoneNumberVerification

FirebasePhoneNumberVerificationException

actual class FirebasePhoneNumberVerificationException(errorCode: Int, message: String, cause: Throwable?) : FirebaseException

The exception that Phone Number Verification fails with; the Android SDK's FirebasePhoneNumberVerificationException.

expect class FirebasePhoneNumberVerificationException(errorCode: Int, message: String, cause: Throwable?) : FirebaseException

The exception that Phone Number Verification fails with; the Android SDK's FirebasePhoneNumberVerificationException.

actual class FirebasePhoneNumberVerificationException(val errorCode: Int, message: String, cause: Throwable?) : FirebaseException

The exception that Phone Number Verification fails with. Its message is the one given, as on Android: the JS FirebaseException would append the cause's message to it.

FirebasePnvStatusCodes

object FirebasePnvStatusCodes

The status codes of Phone Number Verification, the FirebasePhoneNumberVerificationException.errorCode of its failures; mirroring com.google.firebase.pnv.FirebasePnvStatusCodes. On Android the object also extends Google Play services' CommonStatusCodes, whose codes a failure can carry too.

VerificationSupportResult

class VerificationSupportResult(simSlotIndex: Int, carrierId: String, reason: Int)

Whether a SIM of the device supports Phone Number Verification, mirroring com.google.firebase.pnv.VerificationSupportResult; from FirebasePhoneNumberVerification.getVerificationSupportInfo. Two results are equal when their SIM slot, carrier and reason are.

VerificationSupportStatus

@Target(allowedTargets = [AnnotationTarget.TYPE])

annotation class VerificationSupportStatus

The reasons of a VerificationSupportResult (VerificationSupportResult.getReason), mirroring the Android SDK's IntDef annotation com.google.firebase.pnv.VerificationSupportStatus.

VerifiedPhoneNumberTokenResult

actual class VerifiedPhoneNumberTokenResult(token: String)

A verified phone number with its Firebase PNV token, mirroring com.google.firebase.pnv.VerifiedPhoneNumberTokenResult; from FirebasePhoneNumberVerification.getVerifiedPhoneNumber and FirebasePhoneNumberVerification.exchangeCredentialResponseForPhoneNumber. Send getToken to your backend, which verifies its signature: this class only reads the claims of the token, without verifying it.

expect class VerifiedPhoneNumberTokenResult(token: String)

actual class VerifiedPhoneNumberTokenResult(token: String)

Functions

getVerifiedPhoneNumber

actual fun FirebasePhoneNumberVerification.getVerifiedPhoneNumber(context: Any): Task<VerifiedPhoneNumberTokenResult>

Verifies the phone number of a SIM in the device: asks the user for consent through the Android Credential Manager, gets the number from the carrier, and returns it with its Firebase PNV token, which your backend verifies. A successful verification is billed.

actual fun FirebasePhoneNumberVerification.getVerifiedPhoneNumber(context: Any): Task<VerifiedPhoneNumberTokenResult>

Fails with UnsupportedOperationException: Phone Number Verification has no Apple SDK.

expect fun FirebasePhoneNumberVerification.getVerifiedPhoneNumber(context: Any): Task<VerifiedPhoneNumberTokenResult>

actual fun FirebasePhoneNumberVerification.getVerifiedPhoneNumber(context: Any): Task<VerifiedPhoneNumberTokenResult>

Fails with UnsupportedOperationException: Phone Number Verification has no web SDK.

actual fun FirebasePhoneNumberVerification.getVerifiedPhoneNumber(context: Any): Task<VerifiedPhoneNumberTokenResult>

Fails with UnsupportedOperationException: Phone Number Verification has no web SDK.