GetGoogleIdOption

Kotlin | Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

Запрос на получение токена Google ID пользователя.

Броски
java.lang.IllegalArgumentException	Если serverClientId пуст
java.lang.IllegalArgumentException	Если значения filterByAuthorizedAccounts и requestVerifiedPhoneNumber равны true.
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	Если при создании GetGoogleIdOption из пакета возникнет какая-либо ошибка.

Краткое содержание

Вложенные типы
class GetGoogleIdOption.Builder Конструктор для GetGoogleIdOption .

Общественные сопутствующие мероприятия
GetGoogleIdOption	createFrom (data: Bundle ) Вспомогательная функция для создания объекта GetGoogleIdOption из заданного Bundle.

Государственные строители
GetGoogleIdOption ( serverClientId: String , nonce: String ?, filterByAuthorizedAccounts: Boolean , linkedServiceId: String ?, idTokenDepositionScopes: List < String >?, requestVerifiedPhoneNumber: Boolean , autoSelectEnabled: Boolean , claims: List < Claim >?, hostedDomainFilter: String ? )

Общественная собственность
Boolean	autoSelectEnabled Задает поведение автоматического выбора в запросе. Регистрация.
List < Claim >?	claims
Boolean	filterByAuthorizedAccounts Разрешить пользователю выбирать только из учетных записей Google, которые уже авторизованы для входа в ваше приложение; значение по умолчанию — true.
String ?	hostedDomainFilter Домен, по которому следует проводить фильтрацию (например, "exmple.com")
List < String >?	idTokenDepositionScopes В настройках OAuth указывается, что Google потребуется для отправки токена Google ID на серверную часть вашего приложения.
String ?	linkedServiceId Идентификатор службы, используемый при привязке учетных записей к учетной записи Google.
String ?	nonce одноразовый код (nonce), используемый при генерации идентификационного токена.
Boolean	requestVerifiedPhoneNumber Стоит ли запрашивать подтвержденный номер телефона при регистрации.
String	serverClientId Идентификатор клиента сервера, которому будет выдан токен идентификации.

Унаследованные свойства
Из androidx.credentials.CredentialOption Set < ComponentName > allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

Общественные сопутствующие мероприятия

создать из

fun createFrom(data: Bundle): GetGoogleIdOption

Вспомогательная функция для создания объекта GetGoogleIdOption из заданного Bundle.

Параметры
data: Bundle	Пакет, содержащий всю необходимую информацию о GetGoogleIdOption .

Государственные строители

GetGoogleIdOption

GetGoogleIdOption(
    serverClientId: String,
    nonce: String? = null,
    filterByAuthorizedAccounts: Boolean = true,
    linkedServiceId: String? = null,
    idTokenDepositionScopes: List<String>? = null,
    requestVerifiedPhoneNumber: Boolean = false,
    autoSelectEnabled: Boolean = false,
    claims: List<Claim>? = null,
    hostedDomainFilter: String? = null
)

Общественная собственность

autoSelectEnabled

val autoSelectEnabled: Boolean

Задает поведение автоматического выбора в запросе. Регистрация.

претензии

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

Разрешить пользователю выбирать только из учетных записей Google, которые уже авторизованы для входа в ваше приложение; значение по умолчанию — true.

hostedDomainFilter

val hostedDomainFilter: String?

Домен, по которому следует проводить фильтрацию (например, "exmple.com")

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

Области действия OAuth, необходимые Google для отправки токена Google ID на серверную часть вашего приложения. Это необязательный параметр, который можно установить в значение null. Он требуется только в том случае, если Google запрашивает определенные области действия для отправки токена ID.

linkedServiceId

val linkedServiceId: String?

Идентификатор службы, используемый при привязке учетных записей к учетной записи Google.

однократно

val nonce: String?

одноразовый код (nonce), используемый при генерации идентификационного токена.

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

Стоит ли запрашивать подтвержденный номер телефона при регистрации.

serverClientId

val serverClientId: String

Идентификатор клиента сервера, которому будет выдан токен идентификации.