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