GetGoogleIdOption.Builder

class GetGoogleIdOption.Builder


Compilateur pour GetGoogleIdOption.

Résumé

Constructeurs publics

Fonctions publiques

GetGoogleIdOption.Builder
associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
)

Indique si la connexion à l'aide de comptes Google associés aux comptes de vos utilisateurs doit être prise en charge.

GetGoogleIdOption
GetGoogleIdOption.Builder
setAutoSelectEnabled(autoSelectEnabled: Boolean)

Définit le comportement de la sélection automatique dans la requête.

GetGoogleIdOption.Builder
setClaims(claims: List<Claim>)

Définit les revendications à inclure dans le jeton d'identification Google.

GetGoogleIdOption.Builder
setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean)

Indique s'il faut autoriser l'utilisateur à sélectionner uniquement les comptes Google déjà autorisés à se connecter à votre application.

GetGoogleIdOption.Builder
setHostedDomainFilter(hostedDomainFilter: String?)

Définit le filtre de domaine hébergé pour limiter la connexion avec Google aux comptes d'un domaine Google Workspace spécifique.

GetGoogleIdOption.Builder
setNonce(nonce: String?)

Définit le nonce à utiliser lors de la génération d'un jeton d'ID Google.

GetGoogleIdOption.Builder
setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean)

Indique si un numéro de téléphone validé doit être demandé lors de l'inscription.

GetGoogleIdOption.Builder
setServerClientId(serverClientId: String)

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

Builder

Builder()

Fonctions publiques

associateLinkedAccounts

fun associateLinkedAccounts(
    linkedServiceId: String,
    idTokenDepositionScopes: List<String>?
): GetGoogleIdOption.Builder

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
linkedServiceId: String

ID de service utilisé lors de l'association de comptes à un compte Google.

idTokenDepositionScopes: List<String>?

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é.

build

fun build(): GetGoogleIdOption

setAutoSelectEnabled

fun setAutoSelectEnabled(autoSelectEnabled: Boolean): GetGoogleIdOption.Builder

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

fun setClaims(claims: List<Claim>): GetGoogleIdOption.Builder

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.

Paramètres
claims: List<Claim>

une liste de revendications.

setFilterByAuthorizedAccounts

fun setFilterByAuthorizedAccounts(filterByAuthorizedAccounts: Boolean): GetGoogleIdOption.Builder

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
filterByAuthorizedAccounts: Boolean

Indique si l'utilisateur ne peut sélectionner que des comptes Google déjà autorisés à se connecter à votre application.

setHostedDomainFilter

fun setHostedDomainFilter(hostedDomainFilter: String?): GetGoogleIdOption.Builder

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
hostedDomainFilter: String?

le domaine à filtrer (par exemple, "example.com")

setNonce

fun setNonce(nonce: String?): GetGoogleIdOption.Builder

Définit le nonce à utiliser lors de la génération d'un jeton d'ID Google.

Paramètres
nonce: String?

Nonce à utiliser lors de la génération du jeton d'identité

setRequestVerifiedPhoneNumber

fun setRequestVerifiedPhoneNumber(requestVerifiedPhoneNumber: Boolean): GetGoogleIdOption.Builder

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

fun setServerClientId(serverClientId: String): GetGoogleIdOption.Builder

Définit l'ID client du serveur à utiliser comme audience pour les jetons d'identité Google générés lors de la connexion.

Paramètres
serverClientId: String

ID client du serveur auquel le jeton d'identité sera émis