GoogleIdTokenCredential

Kotlin |Java

class GoogleIdTokenCredential : CustomCredential

kotlin.Any
↳	androidx.credentials.Credential
	↳	androidx.credentials.CustomCredential
		↳	com.google.android.libraries.identity.googleid.GoogleIdTokenCredential

Represents the user's Google ID Token granted by the user for app sign-in.

Throws
`java.lang.NullPointerException`	If any of `id` or `idToken` is null.
`java.lang.IllegalArgumentException`	If any of `id` or `idToken` is empty, or if the `idToken` is malformed or cannot be parsed.

Summary

Nested types
`class GoogleIdTokenCredential.Builder` A builder for `GoogleIdTokenCredential`

Constants
`const String`	`BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE` The constant used as a key in the SignInWithGoogleOption request and candidate data bundles, to distinguish SignInWithGoogleOption from GetGoogleIdTokenOption.
`const String`	`TYPE_GOOGLE_ID_TOKEN_CREDENTIAL` A constant represents the type of Google ID Token Credential.
`const String`	`TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL` A constant represents the type of Google ID Token Credential rerieved from SiWG button.

Public companion functions
`GoogleIdTokenCredential`	`createFrom(data: Bundle)`

Public constructors
`GoogleIdTokenCredential( id: String, idToken: String, displayName: String?, familyName: String?, givenName: String?, profilePictureUri: Uri?, phoneNumber: String? )`

Public properties
`String?`	`displayName` display name to show on the entry.
`String?`	`email` The user's email address, parsed from `idToken`.
`String?`	`familyName` user's family name.
`String?`	`givenName` user's given name.
`String`	`id` This property is deprecated. Use uniqueId for the stable user identifier, or email for the user's email address.
`String`	`idToken` user's Google ID Token.
`String?`	`phoneNumber` This property is deprecated. Phone number will no longer be supported.
`Uri?`	`profilePictureUri` user's profile picture uri.
`String`	`uniqueId` The user's unique Google account ID, parsed from `idToken`.

Inherited properties

From androidx.credentials.Credential

`Bundle`	`data`
`String`	`type`

Constants

BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE

const val BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE: String

The constant used as a key in the SignInWithGoogleOption request and candidate data bundles, to distinguish SignInWithGoogleOption from GetGoogleIdTokenOption. While both aforementioned options have the type TYPE_GOOGLE_ID_TOKEN_CREDENTIAL, SignInWithGoogleOption has a sub-type TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL encoded against this key.

TYPE_GOOGLE_ID_TOKEN_CREDENTIAL

const val TYPE_GOOGLE_ID_TOKEN_CREDENTIAL: String

A constant represents the type of Google ID Token Credential.

TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL

const val TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL: String

A constant represents the type of Google ID Token Credential rerieved from SiWG button.

Public companion functions

createFrom

fun createFrom(data: Bundle): GoogleIdTokenCredential

Public constructors