GetGoogleIdOption

public final class GetGoogleIdOption extends GetCustomCredentialOption

java.lang.Object
   ↳ androidx.credentials.CredentialOption
     ↳ androidx.credentials.GetCustomCredentialOption
       ↳ com.google.android.libraries.identity.googleid.GetGoogleIdOption

ユーザーの Google ID トークンを取得するためのリクエスト。

例外
java.lang.IllegalArgumentException java.lang.IllegalArgumentException

serverClientId が空の場合
java.lang.IllegalArgumentException java.lang.IllegalArgumentException

filterByAuthorizedAccounts と requestVerifiedPhoneNumber の両方が true の場合。
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException

バンドルから GetGoogleIdOption の作成中にエラーが発生しました。

まとめ

ネストされた型
public final class GetGoogleIdOption.Builder

GetGoogleIdOption のビルダー。
public static class GetGoogleIdOption.Companion

パブリック コンストラクタ
GetGoogleIdOption(
    @NonNull String serverClientId,
    String nonce,
    boolean filterByAuthorizedAccounts,
    String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes,
    boolean requestVerifiedPhoneNumber,
    boolean autoSelectEnabled
)

public メソッド
static final @NonNull GetGoogleIdOption

特定の Bundle から GetGoogleIdOption を作成するヘルパー関数。
final boolean

リクエストで自動選択動作を設定します。
final boolean

アプリケーションへのログインが承認された Google アカウントからのユーザーの選択のみを許可するかどうかを指定します。デフォルト値は true です。
final List<@NonNull String>

Google がアプリケーションのバックエンド サーバーに Google ID トークンを付与するために必要な OAuth スコープ。
final String

アカウントを Google アカウントにリンクするときに使用するサービス ID
final String

ID トークンの生成時に使用するノンス
final boolean

登録時に確認済みの電話番号をリクエストするかどうかを指定します。
final @NonNull String

ID トークンが発行されるサーバーのクライアント ID

継承されるメソッド
androidx.credentials.CredentialOption から
final @NonNull Set<@NonNull ComponentName>
final @NonNull Bundle
final @NonNull Bundle
final @NonNull String
final boolean
final boolean

パブリック コンストラクタ

GetGoogleIdOption

public GetGoogleIdOption(
    @NonNull String serverClientId,
    String nonce,
    boolean filterByAuthorizedAccounts,
    String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes,
    boolean requestVerifiedPhoneNumber,
    boolean autoSelectEnabled
)

public メソッド

作成元

public static final @NonNull GetGoogleIdOption createFrom(@NonNull Bundle data)

特定の Bundle から GetGoogleIdOption を作成するヘルパー関数。

パラメータ
@NonNull Bundle data

GetGoogleIdOption に関する必要な情報をすべて含むバンドル。

getAutoSelectEnabled

public final boolean getAutoSelectEnabled()

リクエストで自動選択動作を設定します。

getFilterByAuthorizedAccounts

public final boolean getFilterByAuthorizedAccounts()

アプリケーションへのログインが承認された Google アカウントからのユーザーの選択のみを許可するかどうかを指定します。デフォルト値は true です。

getIdTokenDepositionScopes

public final List<@NonNull String> getIdTokenDepositionScopes()

Google がアプリケーションのバックエンド サーバーに Google ID トークンを付与するために必要な OAuth スコープ。これはオプションであり、null に設定できます。Google が特定のスコープに ID トークンを付与できるようにする場合にのみ必要です。

getLinkedServiceId

public final String getLinkedServiceId()

アカウントを Google アカウントにリンクするときに使用するサービス ID

getNonce

public final String getNonce()

ID トークンの生成時に使用するノンス

getRequestVerifiedPhoneNumber を取得する

public final boolean getRequestVerifiedPhoneNumber()

登録時に確認済みの電話番号をリクエストするかどうかを指定します。

getServerClientId

public final @NonNull String getServerClientId()

ID トークンが発行されるサーバーのクライアント ID