電話號碼提示

Phone Number Hint API 是採用 Google Play 服務的程式庫,可提供無摩擦的方式,將使用者的 (SIM 卡) 電話號碼顯示為提示。

使用電話號碼提示的好處包括:

  • 不需要額外權限要求
  • 使用者不必手動輸入電話號碼
  • 不需要 Google 帳戶
  • 未直接與登入/註冊工作流程相關聯
  • 相較於自動填入功能,支援更多 Android 版本

事前準備

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

設定應用程式

將 Phone Number Hint API 的 Google Play 服務依附元件新增至模組的 Gradle 版本檔案,通常為 app/build.gradle

  apply plugin: 'com.android.application'

  ...

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

運作方式

Phone Number Hint API 會使用 PendingIntent 啟動流程。待發送意圖啟動後,系統會向使用者顯示 UI,列出所有 (以 SIM 卡為基礎的) 電話號碼。使用者可以選擇要使用的電話號碼,或取消流程。系統會將所選電話號碼提供給開發人員,讓他們從 Intent 中擷取這組號碼。

電話號碼提示 UI 和設定。
圖 1. 電話號碼提示 UI 和設定

建立 GetPhoneNumbeHintIntentRequest 物件

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

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

要求提供電話號碼提示

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

KotlinJava
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")
}
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,即可擷取電話號碼。

KotlinJava
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")
      }
  }
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);
              }
          }
  });