com.google.api.services.oauth2.model

Class Tokeninfo

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Tokeninfo
extends com.google.api.client.json.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-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Tokeninfo()

Method Summary

Methods

Modifier and Type	Method and Description
Tokeninfo	clone()
java.lang.String	getAccessType() The access type granted with this token.
java.lang.String	getAudience() Who is the intended audience for this token.
java.lang.String	getEmail() The email address of the user.
java.lang.Integer	getExpiresIn() The expiry time of the token, as number of seconds left until expiry.
java.lang.String	getIssuedTo() To whom was the token issued to.
java.lang.String	getScope() The space separated list of scopes granted to this token.
java.lang.String	getTokenHandle() The token handle associated with this token.
java.lang.String	getUserId() The obfuscated user id.
java.lang.Boolean	getVerifiedEmail() Boolean flag which is true if the email address is verified.
Tokeninfo	set(java.lang.String fieldName, java.lang.Object value)
Tokeninfo	setAccessType(java.lang.String accessType) The access type granted with this token.
Tokeninfo	setAudience(java.lang.String audience) Who is the intended audience for this token.
Tokeninfo	setEmail(java.lang.String email) The email address of the user.
Tokeninfo	setExpiresIn(java.lang.Integer expiresIn) The expiry time of the token, as number of seconds left until expiry.
Tokeninfo	setIssuedTo(java.lang.String issuedTo) To whom was the token issued to.
Tokeninfo	setScope(java.lang.String scope) The space separated list of scopes granted to this token.
Tokeninfo	setTokenHandle(java.lang.String tokenHandle) The token handle associated with this token.
Tokeninfo	setUserId(java.lang.String userId) The obfuscated user id.
Tokeninfo	setVerifiedEmail(java.lang.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 java.lang.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(java.lang.String accessType)

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

Parameters:

accessType - accessType or null for none

getAudience

public java.lang.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(java.lang.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 java.lang.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(java.lang.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

getExpiresIn

public java.lang.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(java.lang.Integer expiresIn)

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

Parameters:

expiresIn - expiresIn or null for none

getIssuedTo

public java.lang.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(java.lang.String issuedTo)

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

Parameters:

issuedTo - issuedTo or null for none

getScope

public java.lang.String getScope()

The space separated list of scopes granted to this token.

Returns:

value or null for none

setScope

public Tokeninfo setScope(java.lang.String scope)

The space separated list of scopes granted to this token.

Parameters:

scope - scope or null for none

getTokenHandle

public java.lang.String getTokenHandle()

The token handle associated with this token.

Returns:

value or null for none

setTokenHandle

public Tokeninfo setTokenHandle(java.lang.String tokenHandle)

The token handle associated with this token.

Parameters:

tokenHandle - tokenHandle or null for none

getUserId

public java.lang.String getUserId()

The obfuscated user id.

Returns:

value or null for none

setUserId

public Tokeninfo setUserId(java.lang.String userId)

The obfuscated user id.

Parameters:

userId - userId or null for none

getVerifiedEmail

public java.lang.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(java.lang.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(java.lang.String fieldName,
            java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Tokeninfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson