com.baasbox.android

Class BaasBox

java.lang.Object

com.baasbox.android.BaasBox

public class BaasBox
extends java.lang.Object

This class represents the main context of BaasBox SDK. It must be initialized through BaasBox.initDefault(android.content.Context) before using any other part of the sdk.

It's suggested to initialize the client in the Application:

     
     public class MyBaasBoxApp extends Application {

         private BaasBox box;

         @Override
         public void onCreate() {
             super.onCreate();
             BaasBox.Builder b = new BaasBox.Builder();
             //set your configuration
             //on builder class
             box = b.init();
         }

         public BaasBox getBaasBox(){
             return box;
         }
     }
     
 

Since:

0.7.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaasBox.Builder Builder for BaasBox client
static class	BaasBox.Config The configuration for BaasBox client

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_VERSION Version of the supported server api
BaasBox.Config	config Configuration of this BaasBox client
static java.lang.String	MIN_API_VERSION Minimum supported baasbox server api
static java.lang.String	SDK_VERSION Version of the baasbox sdk.

Method Summary

Modifier and Type	Method and Description
<R> BaasResult<R>	await(RequestToken requestToken)
static BaasBox.Builder	builder(android.content.Context context) Returns a new BaasBox Builder
android.content.Context	getContext()
static BaasBox	getDefault() Returns the baasbox instance for this device if one has been initialized through BaasBox.initDefault(android.content.Context) or null.
static BaasBox	initDefault(android.content.Context context) Initialize BaasBox client with default configuration.
static BaasCloudMessagingService	messagingService() Returns the messaging service instance used by baasbox.
static void	quitClient()
static Rest	rest() Returns the raw passthrough rest client
RequestToken	rest(int method, java.lang.String endpoint, JsonArray body, boolean authenticate, BaasHandler<JsonObject> handler) Deprecated.
RequestToken	rest(int method, java.lang.String endpoint, JsonArray body, int flags, boolean authenticate, BaasHandler<JsonObject> jsonHandler) Deprecated.
RequestToken	rest(int method, java.lang.String endpoint, JsonObject body, boolean authenticate, BaasHandler<JsonObject> handler) Deprecated.
RequestToken	rest(int method, java.lang.String endpoint, JsonObject body, int flags, boolean authenticate, BaasHandler<JsonObject> jsonHandler) Deprecated.
BaasResult<JsonObject>	restSync(int method, java.lang.String endpoint, JsonArray body, boolean authenticate) Deprecated.
BaasResult<JsonObject>	restSync(int method, java.lang.String endpoint, JsonObject body, boolean authenticate) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

SDK_VERSION

public static final java.lang.String SDK_VERSION

Version of the baasbox sdk.

See Also:

Constant Field Values

API_VERSION

public static final java.lang.String API_VERSION

Version of the supported server api

See Also:

Constant Field Values

MIN_API_VERSION

public static final java.lang.String MIN_API_VERSION

Minimum supported baasbox server api

See Also:

Constant Field Values

config

public final BaasBox.Config config

Configuration of this BaasBox client

Method Detail

initDefault

public static BaasBox initDefault(android.content.Context context)

Initialize BaasBox client with default configuration. This must be invoked before any use of the api.

Parameters:

context - cannot be null.

Returns:

the singleton instance of the BaasBox client

quitClient

public static void quitClient()

getDefault

public static BaasBox getDefault()

Returns the baasbox instance for this device if one has been initialized through BaasBox.initDefault(android.content.Context) or null.

Returns:

BAASbox instance

messagingService

public static BaasCloudMessagingService messagingService()

Returns the messaging service instance used by baasbox.

Returns:

BaasCloudMessagingService

rest

public static Rest rest()

Returns the raw passthrough rest client

Returns:

Rest

await

public <R> BaasResult<R> await(RequestToken requestToken)

rest

@Deprecated
public RequestToken rest(int method,
                                     java.lang.String endpoint,
                                     JsonArray body,
                                     int flags,
                                     boolean authenticate,
                                     BaasHandler<JsonObject> jsonHandler)

Deprecated.

Asynchronously sends a raw rest request to the server that is specified by the parameters passed in

Parameters:

flags - bitmask of flags for the request Flags

method - the method to use

endpoint - the resource

body - an optional json array

Returns:

a raw JsonObject response wrapped as BaasResult

rest

@Deprecated
public RequestToken rest(int method,
                                     java.lang.String endpoint,
                                     JsonObject body,
                                     int flags,
                                     boolean authenticate,
                                     BaasHandler<JsonObject> jsonHandler)

Deprecated.

Asynchronously sends a raw rest request to the server that is specified by the parameters passed in

Parameters:

flags - bitmask of flags for the request Flags

method - the method to use

endpoint - the resource

body - an optional json object

Returns:

a raw JsonObject response wrapped as BaasResult

rest

@Deprecated
public RequestToken rest(int method,
                                     java.lang.String endpoint,
                                     JsonArray body,
                                     boolean authenticate,
                                     BaasHandler<JsonObject> handler)

Deprecated.

Asynchronously sends a raw rest request to the server that is specified by the parameters passed in.

Parameters:

method - the method to use

endpoint - the resource

body - an optional jsono bject

authenticate - true if the client should try to refresh authentication automatically

handler - a callback to handle the json response

Returns:

a raw JsonObject response wrapped as BaasResult

rest

@Deprecated
public RequestToken rest(int method,
                                     java.lang.String endpoint,
                                     JsonObject body,
                                     boolean authenticate,
                                     BaasHandler<JsonObject> handler)

Deprecated.

Asynchronously sends a raw rest request to the server that is specified by the parameters passed in.

Parameters:

method - the method to use

endpoint - the resource

body - an optional jsono bject

authenticate - true if the client should try to refresh authentication automatically

handler - a callback to handle the json response

Returns:

a raw JsonObject response wrapped as BaasResult

restSync

@Deprecated
public BaasResult<JsonObject> restSync(int method,
                                                   java.lang.String endpoint,
                                                   JsonArray body,
                                                   boolean authenticate)

Deprecated.

Synchronously sends a raw rest request to the server that is specified by the parameters passed in.

Parameters:

method - the method to use

endpoint - the resource

body - an optional jsono bject

authenticate - true if the client should try to refresh authentication automatically

Returns:

a raw JsonObject response wrapped as BaasResult

restSync

@Deprecated
public BaasResult<JsonObject> restSync(int method,
                                                   java.lang.String endpoint,
                                                   JsonObject body,
                                                   boolean authenticate)

Deprecated.

Synchronously sends a raw rest request to the server that is specified by the parameters passed in.

Parameters:

method - the method to use

endpoint - the resource

body - an optional jsono bject

authenticate - true if the client should try to refresh authentication automatically

Returns:

a raw JsonObject response wrapped as BaasResult

builder

public static BaasBox.Builder builder(android.content.Context context)

Returns a new BaasBox Builder

Parameters:

context -

Returns:

getContext

public final android.content.Context getContext()