com.google.api.services.oauth2.model

Class Tokeninfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.oauth2.model.Tokeninfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Tokeninfo
extends GenericJson

Model definition for Tokeninfo.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google OAuth2 API. For a detailed explanation see: http://code.google.com/p/google-api-java-client/wiki/Json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Tokeninfo()

Method Summary

Methods

Modifier and Type	Method and Description
Tokeninfo	clone()
String	getAccessType() The access type granted with this token.
String	getAudience() Who is the intended audience for this token.
String	getEmail() The email address of the user.
Boolean	getEmailVerified() Boolean flag which is true if the email address is verified.
Integer	getExpiresIn() The expiry time of the token, as number of seconds left until expiry.
Integer	getIssuedAt() The issue time of the token, as number of seconds.
String	getIssuedTo() To whom was the token issued to.
String	getIssuer() Who issued the token.
String	getNonce() Nonce of the id token.
String	getScope() The space separated list of scopes granted to this token.
String	getUserId() The Gaia obfuscated user id.
Boolean	getVerifiedEmail() Boolean flag which is true if the email address is verified.
Tokeninfo	set(String fieldName, Object value)
Tokeninfo	setAccessType(String accessType) The access type granted with this token.
Tokeninfo	setAudience(String audience) Who is the intended audience for this token.
Tokeninfo	setEmail(String email) The email address of the user.
Tokeninfo	setEmailVerified(Boolean emailVerified) Boolean flag which is true if the email address is verified.
Tokeninfo	setExpiresIn(Integer expiresIn) The expiry time of the token, as number of seconds left until expiry.
Tokeninfo	setIssuedAt(Integer issuedAt) The issue time of the token, as number of seconds.
Tokeninfo	setIssuedTo(String issuedTo) To whom was the token issued to.
Tokeninfo	setIssuer(String issuer) Who issued the token.
Tokeninfo	setNonce(String nonce) Nonce of the id token.
Tokeninfo	setScope(String scope) The space separated list of scopes granted to this token.
Tokeninfo	setUserId(String userId) The Gaia obfuscated user id.
Tokeninfo	setVerifiedEmail(Boolean verifiedEmail) Boolean flag which is true if the email address is verified.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tokeninfo

public Tokeninfo()

Method Detail

getAccessType

public String getAccessType()

The access type granted with this token. It can be offline or online.

Returns:

value or null for none

setAccessType

public Tokeninfo setAccessType(String accessType)

The access type granted with this token. It can be offline or online.

Parameters:

accessType - accessType or null for none

getAudience

public String getAudience()

Who is the intended audience for this token. In general the same as issued_to.

Returns:

value or null for none

setAudience

public Tokeninfo setAudience(String audience)

Who is the intended audience for this token. In general the same as issued_to.

Parameters:

audience - audience or null for none

getEmail

public String getEmail()

The email address of the user. Present only if the email scope is present in the request.

Returns:

value or null for none

setEmail

public Tokeninfo setEmail(String email)

The email address of the user. Present only if the email scope is present in the request.

Parameters:

email - email or null for none

getEmailVerified

public Boolean getEmailVerified()

Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.

Returns:

value or null for none

setEmailVerified

public Tokeninfo setEmailVerified(Boolean emailVerified)

Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.

Parameters:

emailVerified - emailVerified or null for none

getExpiresIn

public Integer getExpiresIn()

The expiry time of the token, as number of seconds left until expiry.

Returns:

value or null for none

setExpiresIn

public Tokeninfo setExpiresIn(Integer expiresIn)

The expiry time of the token, as number of seconds left until expiry.

Parameters:

expiresIn - expiresIn or null for none

getIssuedAt

public Integer getIssuedAt()

The issue time of the token, as number of seconds.

Returns:

value or null for none

setIssuedAt

public Tokeninfo setIssuedAt(Integer issuedAt)

The issue time of the token, as number of seconds.

Parameters:

issuedAt - issuedAt or null for none

getIssuedTo

public String getIssuedTo()

To whom was the token issued to. In general the same as audience.

Returns:

value or null for none

setIssuedTo

public Tokeninfo setIssuedTo(String issuedTo)

To whom was the token issued to. In general the same as audience.

Parameters:

issuedTo - issuedTo or null for none

getIssuer

public String getIssuer()

Who issued the token.

Returns:

value or null for none

setIssuer

public Tokeninfo setIssuer(String issuer)

Who issued the token.

Parameters:

issuer - issuer or null for none

getNonce

public String getNonce()

Nonce of the id token.

Returns:

value or null for none

setNonce

public Tokeninfo setNonce(String nonce)

Nonce of the id token.

Parameters:

nonce - nonce or null for none

getScope

public String getScope()

The space separated list of scopes granted to this token.

Returns:

value or null for none

setScope

public Tokeninfo setScope(String scope)

The space separated list of scopes granted to this token.

Parameters:

scope - scope or null for none

getUserId

public String getUserId()

The Gaia obfuscated user id.

Returns:

value or null for none

setUserId

public Tokeninfo setUserId(String userId)

The Gaia obfuscated user id.

Parameters:

userId - userId or null for none

getVerifiedEmail

public Boolean getVerifiedEmail()

Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.

Returns:

value or null for none

setVerifiedEmail

public Tokeninfo setVerifiedEmail(Boolean verifiedEmail)

Boolean flag which is true if the email address is verified. Present only if the email scope is present in the request.

Parameters:

verifiedEmail - verifiedEmail or null for none

set

public Tokeninfo set(String fieldName,
            Object value)

Overrides:

set in class GenericJson

clone

public Tokeninfo clone()

Overrides:

clone in class GenericJson