電話號碼提示

Phone Number Hint API 是採用 Google Play 服務的程式庫，可順暢地顯示使用者的電話號碼 (以 SIM 卡為準) 做為提示。

使用電話號碼提示的優點包括：

  • 不需要額外權限要求
  • 使用者不必手動輸入電話號碼
  • 無須 Google 帳戶
  • 與登入或註冊工作流程沒有直接關聯
  • 與自動填入功能相比，支援的 Android 版本更廣

運作方式

Phone Number Hint API 會使用 PendingIntent 啟動流程。啟動 PendingIntent 後，系統會向使用者顯示 UI，列出所有 (以 SIM 卡為準) 電話號碼。使用者可以選擇要使用的電話號碼，或取消流程。開發人員隨後就能從 Intent 擷取所選電話號碼。

電話號碼提示使用者介面和設定。
圖 1. 電話號碼提示 UI 和設定

如要讓應用程式做好準備，請完成下列各節的步驟。

設定應用程式

將電話號碼提示 API 的 Google Play 服務依附元件新增至模組的 Gradle 建構檔案，通常為 app/build.gradle：

  apply plugin: 'com.android.application'

  ...

  dependencies {
    implementation 'com.google.android.gms:play-services-auth:21.4.0'
  }

建立 GetPhoneNumbeHintIntentRequest 物件

首先，請使用提供的 GetPhoneNumberHintIntentRequest.Builder() 方法建立 GetPhoneNumberHintIntentRequest 物件。這個要求物件隨後可用於取得 Intent，以啟動電話號碼提示流程。

Kotlin

val request: GetPhoneNumberHintIntentRequest = GetPhoneNumberHintIntentRequest.builder().build()

Java

GetPhoneNumberHintIntentRequest request = GetPhoneNumberHintIntentRequest.builder().build();

要求電話號碼提示

呼叫 SignInClient.getPhoneNumberHintIntent()，傳入先前的 GetPhoneNumberHintIntentRequest 物件，即可擷取 PendingIntent 來啟動電話號碼提示流程。

Kotlin

val phoneNumberHintIntentResultLauncher = ...

Identity.getSignInClient(activity)
.getPhoneNumberHintIntent(request)
.addOnSuccessListener { result: PendingIntent ->
  try {
    phoneNumberHintIntentResultLauncher.launch(
      IntentSenderRequest.Builder(result).build()
    )
  } catch (e: Exception) {
      Log.e(TAG, "Launching the PendingIntent failed")
  }
}
.addOnFailureListener {
    Log.e(TAG, "Phone Number Hint failed")
}

Java

ActivityResultLauncher phoneNumberHintIntentResultLauncher = ...

Identity.getSignInClient(activity)
  .getPhoneNumberHintIntent(request)
  .addOnSuccessListener( result -> {
      try {
          phoneNumberHintIntentResultLauncher.launch(result.getIntentSender());
      } catch(Exception e) {
          Log.e(TAG, "Launching the PendingIntent failed", e);
      }
  })
  .addOnFailureListener(e -> {
      Log.e(TAG, "Phone Number Hint failed", e);
  });

正在擷取電話號碼

將 Intent 傳遞至 SignInClient.getPhoneNumberFromIntent，即可擷取電話號碼。

Kotlin

val phoneNumberHintIntentResultLauncher =
registerForActivityResult(ActivityResultContracts.StartIntentSenderForResult()) { result ->
      try {
          val phoneNumber = Identity.getSignInClient(activity).getPhoneNumberFromIntent(result.data)
      } catch(e: Exception) {
          Log.e(TAG, "Phone Number Hint failed")
      }
  }

Java

ActivityResultLauncher phoneNumberHintIntentResultLauncher =
  registerForActivityResult(
      new ActivityResultContracts.StartActivityForResult(),
      new ActivityResultCallback() {
          @Override
          public void onActivityResult(ActivityResult result) {
              try {
                  String phoneNumber = Identity.getSignInClient(activity).getPhoneNumberFromIntent(result.getData());
              } catch {
                  Log.e(TAG, "Phone Number Hint failed", e);
              }
          }
  });