Package com.baasbox.android

Provides classes necessary to use the BaasBox API, and the main entry point to configure the client.

See: Description

Interface Summary

Interface	Description
BaasHandler<R>	Interface definition for a callback to be invoked when BaasBox responds to an asynchronous request.
DataStreamHandler<R>	Interface definition for a callback to be invoked when new data is available in an asynchronous streaming request.
ExceptionHandler	This is invoked when an unexpected error happens during the execution of an asynchronous operation.
Rest	Created by Andrea Tortorella on 1/12/15.

Class Summary

Class	Description
BaasACL	The set of permission to use at the creation of a file.
BaasACL.Builder
BaasAsset	Collection of functions that work with assets.
BaasAssetId	Created by Andrea Tortorella on 08/09/14.
BaasBox	This class represents the main context of BaasBox SDK.
BaasBox.Builder	Builder for BaasBox client
BaasBox.Config	The configuration for BaasBox client
BaasCloudMessagingService	Created by Andrea Tortorella on 14/04/14.
BaasCloudMessagingService.MessageBuilder
BaasDocument	Represents a BaasBox document.
BaasFile	Represents a BaasBox file.
BaasLink	Represents a BaasBox Link between objects Created by Andrea Tortorella on 13/08/14.
BaasObject	Base class for remote resources that can be saved and retrieved from BaasBox.
BaasQuery	A query with specific parameters to a collection endpoint Created by Andrea Tortorella on 07/03/14.
BaasQuery.Builder
BaasQuery.Criteria
BaasResult<T>	This class represents the result of a BaasBox request.
BaasStream	An input streams over the content of a response that gives access to the content type, the content length and the id of the associated BaasBox file.
BaasUser	Represents a User of the BaasBox service.
BaasUser.Social
BuildConfig
Plugin<T extends Plugin.Options>	Created by Andrea Tortorella on 09/09/14.
Plugin.Options
Plugin.Options.Empty
RequestOptions	Options that can be used to modify how a request will be executed.
RequestToken	A handle to an asynchronous request.
Role	Constants and utilites for managing and usin roles.

Enum Summary

Enum	Description
BaasBox.Config.AuthType	The supported authentication types.
BaasUser.Scope	Scopes of visibility of user related data.
Grant	An enumeration representing the possible access grants to BaasObject.
Rest.Method
SaveMode	Mode used during update operations.

Exception Summary

Exception	Description
BaasApiException	A subclass of BaasException.
BaasCancellationException	A subclass of BaasException that is thrown when the user tries to access the result of a cancelled request.
BaasClientException	A subclass of BaasApiException indicating an error due a wrong request.
BaasException	Base class of all the exceptions thrown by the BaasBox android sdk.
BaasInvalidSessionException	This is a particular subclass of BaasClientException indicating an invalid state of the user session.
BaasIOException	A subclass of BaasException that represents an I/O exception.
BaasRuntimeException	Created by Andrea Tortorella on 09/02/14.
BaasServerException	A subclass of BaasApiException indicating an error due a problem within the server.

Package com.baasbox.android Description

Provides classes necessary to use the BaasBox API, and the main entry point to configure the client.
A BaasBox connected app needs to initialize the client through the BaasBox class providing an optional configuration.
Once this initialization has been done, the server functionality may be accessed through wrapper classes for each kind of resource exposed via the rest api.
Each rest endpoint is accessible through asynchronous methods, that give a callback interface using BaasHandler general interface, Asyncrhonous calls may be canceled or suspended for later resumption, through the handle RequestToken returned by asynchronous calls.
The api also provides synchronous alternatives using the sync version of the methods, mostly for cases when the request is initiated by another thread other than the main one.
Different resources are wrapped by specific classes:

• BaasUser a user of the BaasBox server
• BaasDocument a json document stored in a collectiont on the server
• BaasFile a blob stored on the server

Since remote calls done through http, may fail results are always wrapped in an option result type BaasResult