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

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.models.BoxJsonObject

BoxJsonObject.BoxJsonObjectCreator<E extends BoxJsonObject>

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

Constructor Summary

Constructors

Constructor and Description
BoxAuthenticationInfo() Constructs an empty BoxAuthenticationInfo object.
BoxAuthenticationInfo(com.eclipsesource.json.JsonObject object) Constructs a BoxAuthenticationInfo with the provided map values.

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessToken()
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()
java.lang.String	getBaseDomain() Deprecated.
java.lang.String	getClientId()
java.lang.Long	getRefreshTime() Time the OAuth last refreshed.
BoxUser	getUser()
java.lang.String	refreshToken()
void	setAccessToken(java.lang.String accessToken) Setter for access token.
void	setBaseDomain(java.lang.String baseDomain) Deprecated.
void	setClientId(java.lang.String clientId) Setter for client id.
void	setExpiresIn(java.lang.Long expiresIn)
void	setRefreshTime(java.lang.Long refreshTime) Set the refresh time.
void	setRefreshToken(java.lang.String refreshToken) 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

addInJsonArray, addInJsonArray, createFromJson, createFromJson, equals, getBoxJsonObjectCreator, getPropertiesKeySet, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsJsonArray, getPropertyAsJsonObject, getPropertyAsJsonObjectArray, getPropertyAsLong, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringHashSet, getPropertyValue, hashCode, parseJSONMember, remove, set, set, set, set, set, set, set, set, set, toJson, toJsonObject

Methods inherited from class java.lang.Object

finalize, getClass, 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.

BoxAuthenticationInfo

public BoxAuthenticationInfo(com.eclipsesource.json.JsonObject object)

Constructs a BoxAuthenticationInfo with the provided map values.

Parameters:

object - JsonObject that represents this 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.

Parameters:

targetInfo - target authentication information to copy information into.

sourceInfo - source information to copy information from.

getClientId

public java.lang.String getClientId()

Returns:

the box client id associated with this session.

accessToken

public java.lang.String accessToken()

Returns:

OAuth access token.

refreshToken

public java.lang.String refreshToken()

Returns:

OAuth refresh token.

expiresIn

public java.lang.Long expiresIn()

Returns:

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

setExpiresIn

public void setExpiresIn(java.lang.Long expiresIn)

Parameters:

expiresIn - amount of time in which access token is valid for.

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.

Parameters:

refreshTime - device system time of last refresh.

setClientId

public void setClientId(java.lang.String clientId)

Setter for client id.

Parameters:

clientId - client id associated with this authentication.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Setter for access token.

Parameters:

accessToken - access token associated with this authentication

setRefreshToken

public void setRefreshToken(java.lang.String refreshToken)

Setter for refresh token

Parameters:

refreshToken - refresh token associated with this authentication

setBaseDomain

@Deprecated
public void setBaseDomain(java.lang.String baseDomain)

Deprecated.

Setter for base domain. Base domain is no longer being used by any enterprises.

Parameters:

baseDomain - base domain corresponding to this authentication

getBaseDomain

@Deprecated
public java.lang.String getBaseDomain()

Deprecated.

Base domain is no longer being used by any enterprises.

Returns:

Get the base domain associated with this user.

setUser

public void setUser(BoxUser user)

Setter for BoxUser corresponding to this authentication info.

Parameters:

user - a box user this authentication corresponds to.

getUser

public BoxUser getUser()

Returns:

Get the BoxUser related to this authentication info.

wipeOutAuth

public void wipeOutAuth()

Wipe out all the information in this object.