GetGoogleIdOption.Builder
public final class GetGoogleIdOption.Builder
Конструктор для GetGoogleIdOption .
Краткое содержание
Государственные строители |
|---|
Builder () |
Общедоступные методы | |
|---|---|
final @ NonNull GetGoogleIdOption.Builder | associateLinkedAccounts (Определяет, следует ли поддерживать вход в систему с использованием учетных записей Google, связанных с учетными записями ваших пользователей. |
final @ NonNull GetGoogleIdOption | build () |
final @ NonNull GetGoogleIdOption.Builder | setAutoSelectEnabled (boolean autoSelectEnabled)Задает поведение автоматического выбора в запросе. |
final @ NonNull GetGoogleIdOption.Builder | Задает параметры, которые будут включены в токен Google ID. |
final @ NonNull GetGoogleIdOption.Builder | setFilterByAuthorizedAccounts (boolean filterByAuthorizedAccounts)Этот параметр определяет, разрешать ли пользователю выбирать только те учетные записи Google, которые уже авторизованы для входа в ваше приложение. |
final @ NonNull GetGoogleIdOption.Builder | setHostedDomainFilter ( String hostedDomainFilter)Устанавливает фильтр для размещенного домена, чтобы ограничить вход через Google только для учетных записей в определенном домене Google Workspace. |
final @ NonNull GetGoogleIdOption.Builder | Задает значение nonce, используемое при генерации токена Google ID. |
final @ NonNull GetGoogleIdOption.Builder | setRequestVerifiedPhoneNumber (boolean requestVerifiedPhoneNumber)Определяет, следует ли запрашивать подтвержденный номер телефона при регистрации. |
final @ NonNull GetGoogleIdOption.Builder | setServerClientId (@ NonNull String serverClientId)Устанавливает идентификатор клиента сервера, который будет использоваться в качестве целевой аудитории для токенов Google ID, генерируемых во время входа в систему. |
Государственные строители
Общедоступные методы
associateLinkedAccounts
public final @NonNull GetGoogleIdOption.Builder associateLinkedAccounts(
@NonNull String linkedServiceId,
List<@NonNull String> idTokenDepositionScopes
)
Определяет, следует ли поддерживать вход в систему с использованием учетных записей Google, связанных с учетными записями ваших пользователей.
При выборе таких учетных данных токен Google ID для учетной записи Google, к которой привязана выбранная учетная запись, сначала будет отправлен на ваш сервер, а затем возвращен вам. Аналогично обычному входу в систему, ваш бэкэнд может использовать токен ID для авторизации пользователя. Обратите внимание, что отправка токена ID произойдет только при первом входе в систему с использованием этих учетных данных. При последующих входах в систему отправка токена ID не потребуется, поскольку токен ID уже будет связан с учетной записью пользователя.
| Параметры | |
|---|---|
@ NonNull String linkedServiceId | Идентификатор службы, используемый при привязке учетных записей к учетной записи Google. |
List <@ NonNull String > idTokenDepositionScopes | Области действия OAuth, необходимые Google для отправки токена Google ID на серверную часть вашего приложения. Это необязательный параметр, который можно установить в значение null. Он требуется только в том случае, если Google запрашивает определенные области действия для отправки токена ID. |
setAutoSelectEnabled
public final @NonNull GetGoogleIdOption.Builder setAutoSelectEnabled(boolean autoSelectEnabled)
Задает поведение автоматического выбора в запросе.
Для пользователей, давших согласие на использование функции автоматического выбора, учетные данные выбираются автоматически без ожидания каких-либо действий со стороны пользователя (например, нажатия кнопки «продолжить»). Автоматический выбор учетных данных возможен, если 1) для входа в систему можно использовать только одни учетные данные; и 2) для этих учетных данных не требуется никаких дополнительных действий (например, для учетной записи Google уже получены разрешения на обмен данными).
setClaims
public final @NonNull GetGoogleIdOption.Builder setClaims(@NonNull List<@NonNull Claim> claims)
Задает параметры, которые будут включены в токен Google ID.
Список доступных утверждений см. в документации . Любые неподтвержденные утверждения будут проигнорированы.
setFilterByAuthorizedAccounts
public final @NonNull GetGoogleIdOption.Builder setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts)
Этот параметр определяет, разрешать ли пользователю выбирать только те учетные записи Google, которые уже авторизованы для входа в ваше приложение. Значение по умолчанию — true.
Если установлено значение {@code true}, пользователь не сможет выбрать ни одну учетную запись Google, для которой в противном случае потребовалось бы явное разрешение на передачу основных данных профиля/электронной почты вашему приложению. Это может несколько упростить процесс входа в систему и гарантировать, что возвращаемые учетные данные предназначены для «повторного пользователя», но ограничивает свободу выбора пользователя среди всех учетных записей Google на устройстве.
| Параметры | |
|---|---|
boolean filterByAuthorizedAccounts | Разрешить ли пользователю выбирать только из учетных записей Google, которые уже авторизованы для входа в ваше приложение |
setHostedDomainFilter
public final @NonNull GetGoogleIdOption.Builder setHostedDomainFilter(String hostedDomainFilter)
Устанавливает фильтр для размещенного домена, чтобы ограничить вход через Google только для учетных записей в определенном домене Google Workspace.
Передача значения null или пустой строки не приведет к фильтрации.
| Параметры | |
|---|---|
String hostedDomainFilter | Домен, по которому следует проводить фильтрацию (например, "exmple.com") |
setNonce
public final @NonNull GetGoogleIdOption.Builder setNonce(String nonce)
Задает значение nonce, используемое при генерации токена Google ID.
| Параметры | |
|---|---|
String nonce | одноразовый код (nonce), используемый при генерации идентификационного токена. |
setRequestVerifiedPhoneNumber
public final @NonNull GetGoogleIdOption.Builder setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber)
Определяет, следует ли запрашивать подтвержденный номер телефона при регистрации.
Для использования этой функции необходимо явно установить значение false в поле [filterByAuthorizedAccounts], поскольку эта функция доступна только во время регистрации.
setServerClientId
public final @NonNull GetGoogleIdOption.Builder setServerClientId(@NonNull String serverClientId)
Устанавливает идентификатор клиента сервера, который будет использоваться в качестве целевой аудитории для токенов Google ID, генерируемых во время входа в систему.