com.box.androidsdk.content.auth

Class BoxAuthentication.BoxAuthenticationInfo

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.auth.BoxAuthentication.BoxAuthenticationInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticatedAccountsAdapter.DifferentAuthenticationInfo

Enclosing class:

BoxAuthentication

public static class BoxAuthentication.BoxAuthenticationInfo
extends BoxJsonObject

Object holding authentication info.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_ACCESS_TOKEN
static java.lang.String	FIELD_BASE_DOMAIN
static java.lang.String	FIELD_CLIENT_ID
static java.lang.String	FIELD_EXPIRES_IN
static java.lang.String	FIELD_REFRESH_TOKEN
static java.lang.String	FIELD_USER

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxAuthenticationInfo() Constructs an empty BoxAuthenticationInfo object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessToken() OAuth access token.
BoxAuthentication.BoxAuthenticationInfo	clone() Creates a clone of a BoxAuthenticationInfo object.
static void	cloneInfo(BoxAuthentication.BoxAuthenticationInfo targetInfo, BoxAuthentication.BoxAuthenticationInfo sourceInfo) Clone BoxAuthenticationInfo from source object into target object.
java.lang.Long	expiresIn() Time the oauth is going to expire (in ms).
java.lang.String	getBaseDomain() Get the base domain associated with this user.
java.lang.String	getClientId()
java.lang.Long	getRefreshTime() Time the OAuth last refreshed.
BoxUser	getUser() Get the BoxUser related to this authentication info.
protected void	parseJSONMember(com.eclipsesource.json.JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
java.lang.String	refreshToken() OAuth refresh token.
void	setAccessToken(java.lang.String access) Setter for access token.
void	setBaseDomain(java.lang.String baseDomain) Setter for base domain.
void	setClientId(java.lang.String clientId)
void	setRefreshTime(java.lang.Long refreshTime) Set the refresh time.
void	setRefreshToken(java.lang.String refresh) Setter for refresh token
void	setUser(BoxUser user) Setter for BoxUser corresponding to this authentication info.
void	wipeOutAuth() Wipe out all the information in this object.

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

createFromJson, createFromJson, getPropertiesAsHashMap, parseJsonObject, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_CLIENT_ID

public static final java.lang.String FIELD_CLIENT_ID

See Also:

Constant Field Values

FIELD_ACCESS_TOKEN

public static final java.lang.String FIELD_ACCESS_TOKEN

See Also:

Constant Field Values

FIELD_REFRESH_TOKEN

public static final java.lang.String FIELD_REFRESH_TOKEN

See Also:

Constant Field Values

FIELD_EXPIRES_IN

public static final java.lang.String FIELD_EXPIRES_IN

See Also:

Constant Field Values

FIELD_USER

public static final java.lang.String FIELD_USER

See Also:

Constant Field Values

FIELD_BASE_DOMAIN

public static final java.lang.String FIELD_BASE_DOMAIN

See Also:

Constant Field Values

Constructor Detail

BoxAuthenticationInfo

public BoxAuthenticationInfo()

Constructs an empty BoxAuthenticationInfo object.

Method Detail

clone

public BoxAuthentication.BoxAuthenticationInfo clone()

Creates a clone of a BoxAuthenticationInfo object.

Overrides:

clone in class java.lang.Object

Returns:

clone of BoxAuthenticationInfo object.

cloneInfo

public static void cloneInfo(BoxAuthentication.BoxAuthenticationInfo targetInfo,
                             BoxAuthentication.BoxAuthenticationInfo sourceInfo)

Clone BoxAuthenticationInfo from source object into target object. Note that this method assumes the two objects have same user. Otherwise it would not make sense to do a clone operation.

getClientId

public java.lang.String getClientId()

accessToken

public java.lang.String accessToken()

OAuth access token.

refreshToken

public java.lang.String refreshToken()

OAuth refresh token.

expiresIn

public java.lang.Long expiresIn()

Time the oauth is going to expire (in ms).

getRefreshTime

public java.lang.Long getRefreshTime()

Time the OAuth last refreshed.

Returns:

time the OAuth last refreshed.

setRefreshTime

public void setRefreshTime(java.lang.Long refreshTime)

Set the refresh time. Called when refresh happened.

setClientId

public void setClientId(java.lang.String clientId)

setAccessToken

public void setAccessToken(java.lang.String access)

Setter for access token.

setRefreshToken

public void setRefreshToken(java.lang.String refresh)

Setter for refresh token

setBaseDomain

public void setBaseDomain(java.lang.String baseDomain)

Setter for base domain.

getBaseDomain

public java.lang.String getBaseDomain()

Get the base domain associated with this user.

setUser

public void setUser(BoxUser user)

Setter for BoxUser corresponding to this authentication info.

getUser

public BoxUser getUser()

Get the BoxUser related to this authentication info.

wipeOutAuth

public void wipeOutAuth()

Wipe out all the information in this object.

parseJSONMember

protected void parseJSONMember(com.eclipsesource.json.JsonObject.Member member)

Description copied from class: BoxJsonObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Overrides:

parseJSONMember in class BoxJsonObject

Parameters:

member - the JSON member to be parsed.