GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
Compilateur pour GetGoogleIdOption.
Résumé
Constructeurs publics |
|---|
Builder() |
Méthodes publiques |
|
|---|---|
final @NonNull GetGoogleIdOption.Builder |
associateLinkedAccounts(Indique si la connexion à l'aide de comptes Google associés aux comptes de vos utilisateurs doit être prise en charge. |
final @NonNull GetGoogleIdOption |
build() |
final @NonNull GetGoogleIdOption.Builder |
setAutoSelectEnabled(boolean autoSelectEnabled)Définit le comportement de la sélection automatique dans la requête. |
final @NonNull GetGoogleIdOption.Builder |
Définit les revendications à inclure dans le jeton d'identification Google. |
final @NonNull GetGoogleIdOption.Builder |
setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)Indique s'il faut autoriser l'utilisateur à sélectionner uniquement les comptes Google déjà autorisés à se connecter à votre application. |
final @NonNull GetGoogleIdOption.Builder |
setHostedDomainFilter(String hostedDomainFilter)Définit le filtre de domaine hébergé pour limiter la connexion avec Google aux comptes d'un domaine Google Workspace spécifique. |
final @NonNull GetGoogleIdOption.Builder |
Définit le nonce à utiliser lors de la génération d'un jeton d'ID Google. |
final @NonNull GetGoogleIdOption.Builder |
setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)Indique si un numéro de téléphone validé doit être demandé lors de l'inscription. |
final @NonNull GetGoogleIdOption.Builder |
setServerClientId(@NonNull String serverClientId)Définit l'ID client du serveur à utiliser comme audience pour les jetons d'identité Google générés lors de la connexion. |
Constructeurs publics
Méthodes publiques
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
Indique si la connexion à l'aide de comptes Google associés aux comptes de vos utilisateurs doit être prise en charge.
Lorsqu'un tel identifiant est sélectionné, un jeton d'identité Google pour le compte Google auquel le compte sélectionné est associé est d'abord déposé sur votre serveur, puis vous est renvoyé. Comme pour la connexion habituelle, votre backend peut utiliser le jeton d'identité pour connecter l'utilisateur. Notez que le jeton d'identité ne sera déposé que lors de la première connexion à l'aide de ces identifiants. Les connexions ultérieures ne nécessiteront pas de dépôt, car le jeton d'identité aura déjà été associé au compte de votre utilisateur.
| Paramètres | |
|---|---|
@NonNull String linkedServiceId |
ID de service utilisé lors de l'association de comptes à un compte Google. |
List<@NonNull String> idTokenDepositionScopes |
Il s'agit des niveaux d'accès OAuth dont Google aura besoin pour déposer un jeton d'ID Google sur le serveur backend de votre application. Cette valeur est facultative et peut être définie sur "null". Obligatoire uniquement si Google exige des autorisations spécifiques pour pouvoir déposer le jeton d'identité. |
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
Définit le comportement de la sélection automatique dans la requête.
Pour les utilisateurs qui activent la sélection automatique, une pièce d'identité peut être sélectionnée automatiquement sans attendre une action de l'utilisateur (par exemple, appuyer sur le bouton "Continuer"). Un identifiant peut être sélectionné automatiquement si 1) un seul identifiant peut être utilisé pour la connexion ; et 2) aucune autre action n'est requise pour cet identifiant (par exemple, les autorisations de partage de données sont déjà collectées pour un compte Google).
setClaims
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
Définit les revendications à inclure dans le jeton d'identification Google.
Pour obtenir la liste des revendications disponibles, consultez la documentation. Les revendications non acceptées seront ignorées.
setFilterByAuthorizedAccounts
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
Indique s'il faut autoriser l'utilisateur à sélectionner uniquement les comptes Google déjà autorisés à se connecter à votre application. La valeur par défaut est "true".
Si la valeur est définie sur {@code true}, l'utilisateur ne pourra sélectionner aucun compte Google qui nécessiterait une autorisation explicite pour partager des données de profil/d'adresse e-mail de base avec votre application. Cela peut réduire les frictions dans le parcours de connexion de l'utilisateur et garantit que l'identifiant renvoyé est destiné à un "utilisateur connu", mais limite la liberté de l'utilisateur de choisir parmi tous les comptes Google sur l'appareil.
| Paramètres | |
|---|---|
boolean filterByAuthorizedAccounts |
Indique si l'utilisateur ne peut sélectionner que des comptes Google déjà autorisés à se connecter à votre application. |
setHostedDomainFilter
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
Définit le filtre de domaine hébergé pour limiter la connexion avec Google aux comptes d'un domaine Google Workspace spécifique.
Si vous transmettez une chaîne nulle ou vide, aucun filtrage ne sera effectué.
| Paramètres | |
|---|---|
String hostedDomainFilter |
le domaine à filtrer (par exemple, "example.com") |
setNonce
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
Définit le nonce à utiliser lors de la génération d'un jeton d'ID Google.
| Paramètres | |
|---|---|
String nonce |
Nonce à utiliser lors de la génération du jeton d'identité |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
Indique si un numéro de téléphone validé doit être demandé lors de l'inscription.
Pour utiliser cette fonctionnalité, le champ [filterByAuthorizedAccounts] doit être explicitement défini sur "false", car cette fonctionnalité n'est disponible que lors des inscriptions.
setServerClientId
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
Définit l'ID client du serveur à utiliser comme audience pour les jetons d'identité Google générés lors de la connexion.