com.box.boxandroidlibv2

Class BoxAndroidClient

java.lang.Object

com.box.boxjavalibv2.dao.BoxBase

com.box.boxjavalibv2.BoxClient

com.box.boxandroidlibv2.BoxAndroidClient

All Implemented Interfaces:

IAuthFlowListener

public class BoxAndroidClient
extends BoxClient

This is the main entrance of the sdk. The client contains all resource managers and also handles authentication. Make sure you call authenticate method before making any api calls. you can use the resource managers to execute requests synchronously against the Box REST API(V2). Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

Constructor and Description
BoxAndroidClient(java.lang.String clientId, java.lang.String clientSecret, IBoxConfig config) Deprecated.
BoxAndroidClient(java.lang.String clientId, java.lang.String clientSecret, IBoxResourceHub resourcehub, IBoxJSONParser parser, IBoxConfig config)
BoxAndroidClient(java.lang.String clientId, java.lang.String clientSecret, IBoxResourceHub hub, IBoxJSONParser parser, IBoxConfig config, BoxConnectionManagerBuilder.BoxConnectionManager connectionManager) This constructor has some connection parameters.

Method Summary

Methods

Modifier and Type	Method and Description
protected IBoxResourceHub	createResourceHub() Create a resource hub
protected BoxOAuthToken	getOAuthTokenFromMessage(IAuthFlowMessage message)

Methods inherited from class com.box.boxjavalibv2.BoxClient

addOAuthRefreshListener, authenticate, authenticate, authenticateFromSecureStorage, createAuthDataController, createAuthorization, createJSONParser, createMonitoredRestClient, createRestClient, getAuth, getAuthData, getAuthState, getBoxItemsManager, getCollaborationsManager, getCommentsManager, getConfig, getEventsManager, getFilesManager, getFoldersManager, getGroupsManager, getJSONParser, getOAuthDataController, getOAuthManager, getPluginManager, getResourceHub, getResourceManagerWithSharedLinkAuth, getRestClient, getSearchManager, getSharedBoxItemsManager, getSharedCommentsManager, getSharedFilesManager, getSharedFoldersManager, getSharedItemAuth, getSharedItemsManager, getTrashManager, getUsersManager, isAuthenticated, onAuthFlowEvent, onAuthFlowException, onAuthFlowMessage, pluginResourceManager, saveAuth, setAutoRefreshOAuth, setConnectionOpen, setConnectionTimeOut

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxAndroidClient

public BoxAndroidClient(java.lang.String clientId,
                java.lang.String clientSecret,
                IBoxResourceHub hub,
                IBoxJSONParser parser,
                IBoxConfig config,
                BoxConnectionManagerBuilder.BoxConnectionManager connectionManager)

This constructor has some connection parameters. They are used to periodically close idle connections that HttpClient opens.

Parameters:

clientId - client id, you can get it from dev console.

clientSecret - client secret, you can get it from dev console.

hub - resource hub. use null if you want to use default one.

parser - json parser, use null if you want to use default one(Jackson).

config - BoxConfig. User BoxAndroidConfigBuilder to build. Normally you only need default config: (new BoxAndroidConfigBuilder()).build()

connectionManager - BoxConnectionManager. Normally you only need default connection manager: (new BoxConnectionManagerBuilder()).build()

BoxAndroidClient

public BoxAndroidClient(java.lang.String clientId,
                java.lang.String clientSecret,
                IBoxResourceHub resourcehub,
                IBoxJSONParser parser,
                IBoxConfig config)

Parameters:

clientId - client id

clientSecret - client secret

resourcehub - resource hub, use null for default resource hub.

parser - json parser, use null for default parser.

config - BoxConfig. User BoxAndroidConfigBuilder to build. Normally you only need default config: (new BoxAndroidConfigBuilder()).build()

BoxAndroidClient

@Deprecated
public BoxAndroidClient(java.lang.String clientId,
                           java.lang.String clientSecret,
                           IBoxConfig config)

Deprecated.

Method Detail

createResourceHub

protected IBoxResourceHub createResourceHub()

Description copied from class: BoxClient

Create a resource hub

Overrides:

createResourceHub in class BoxClient

Returns:

IBoxResourceHub

getOAuthTokenFromMessage

protected BoxOAuthToken getOAuthTokenFromMessage(IAuthFlowMessage message)

Overrides:

getOAuthTokenFromMessage in class BoxClient