buzz.getcoco.iot

Class CocoClient

java.lang.Object

buzz.getcoco.iot.CocoClient

public class CocoClient
extends java.lang.Object

The base SDK Class the developer will call. CocoClient class follows the singleton design pattern which upon instantiation initializes GSON builders, Native handlers, callback handlers and facilitates subscription to callbacks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CocoClient.AccessTokensListener The listener which will be triggered after the NativeCallbacks.accessTokenCallback(java.lang.String, int, java.lang.Object).
static class	CocoClient.Configurator NOTE: This is a singleton builder.
static class	CocoClient.ConnectivityMode An enum denoting possible values of mode of connectivity.
static class	CocoClient.ConnectivityTimers This class defines default SDK timeouts and allows developer to set his/her own SDK timers.
static interface	CocoClient.NetworkListListener The listener which will be triggered after the NativeCallbacks.networkListCallback(java.lang.String[], java.lang.String[], int[], int[], int[], java.lang.Object).

Method Summary

Modifier and Type	Method and Description
void	addSubscription(CallbacksInterface nativeCallbacks) A function to add extra subscribers for callbacks.
protected void	clearNetworks()
void	clearSubscriptions() A function to clear all the subscriptions to the NativeCallbacks.
boolean	containsNetwork(java.lang.String networkId)
void	getAccessTokens(CocoClient.AccessTokensListener listener) This function can be used to get OAuth Tokens from the c-sdk.
void	getAllNetworks(CocoClient.NetworkListListener listener) This function is used to request the available networks from the server.
static CocoClient	getInstance() This function returns the CocoClient instance that was created earlier.
<T extends Network> T	getNetwork(java.lang.String networkId)
java.util.Map<java.lang.String,Network>	getNetworkMap() This function is used to return the HashMap that the sdk uses to map the networkIds to the network Objects.
Network[]	getSavedNetworks() This function return an array of networks which are previous connected by user.
java.lang.String	getVersionInfo()
void	informNetworkChange()
protected void	internalAddNetwork(Network network)
protected void	internalRemoveNetwork(java.lang.String networkId)
void	invalidateAccessToken() A function to invalidate the current accessToken.
void	removeSubscription(CallbacksInterface nativeCallbacks) A function to remove the subscription of an object.
Network	restoreNetworkState(java.lang.String jsonNetworkState) A function to restore the state of the network during second run.
void	setConnectivityMode(CocoClient.ConnectivityMode mode) sets the connectivity mode using Native method defined using JNI.
void	setListener(PlatformInterface listener) A function to set the listener for Platform callbacks.
void	setTokens(java.lang.String response) This function must be called when OAuthCallback is received.

Methods inherited from class java.lang.Object

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

Method Detail

getVersionInfo

public java.lang.String getVersionInfo()

clearSubscriptions

public void clearSubscriptions()

A function to clear all the subscriptions to the NativeCallbacks.

addSubscription

public void addSubscription(CallbacksInterface nativeCallbacks)

A function to add extra subscribers for callbacks.

Parameters:

nativeCallbacks - The object which has to be notified

removeSubscription

public void removeSubscription(CallbacksInterface nativeCallbacks)

A function to remove the subscription of an object.

Parameters:

nativeCallbacks - The object which has to be removed

setListener

public void setListener(PlatformInterface listener)

A function to set the listener for Platform callbacks.

Parameters:

listener - The listener which will get the callbacks

invalidateAccessToken

public void invalidateAccessToken()

A function to invalidate the current accessToken.

Throws:

java.lang.RuntimeException - on Failure

getInstance

public static CocoClient getInstance()

This function returns the CocoClient instance that was created earlier.

Returns:

This functions returns the CocoClient instance that has been created

getSavedNetworks

public Network[] getSavedNetworks()

This function return an array of networks which are previous connected by user. This function is an abstraction for Native.nativeGetSavedNetworks().

Returns:

Network[] an Array of Network Objects which the developer can leverage to connect.NOTE: It is recommended to use static function present in the Network class to connect to an array of networks instead of using connect function in individual objects

getAllNetworks

public void getAllNetworks(CocoClient.NetworkListListener listener)

This function is used to request the available networks from the server. This function is an abstraction for native getAllNetworks function.

restoreNetworkState

public Network restoreNetworkState(java.lang.String jsonNetworkState)

A function to restore the state of the network during second run.

Parameters:

jsonNetworkState - The json formatted string which is returned by Network.saveState()

Returns:

Network The network object which is restored.

Throws:

com.google.gson.JsonParseException - on malformed JSONs

java.lang.IllegalStateException - on initiating restore on already connected or connecting networks

See Also:

Network.saveState()

setTokens

public void setTokens(java.lang.String response)

This function must be called when OAuthCallback is received. The tokens must be passed as a stringified JSON response NOTE: This function must be called after the NativeCallbacks.authCallback(java.lang.String, java.lang.String) is received to set the tokens.

Parameters:

response - The stringified JSON response.

Throws:

java.lang.RuntimeException - Throws an exception on failure to setTokens in database.

getAccessTokens

public void getAccessTokens(CocoClient.AccessTokensListener listener)

This function can be used to get OAuth Tokens from the c-sdk. The tokens can be received in the getTokensCallback().

Parameters:

listener - The listener that is triggered after callbacks.

getNetworkMap

public java.util.Map<java.lang.String,Network> getNetworkMap()

This function is used to return the HashMap that the sdk uses to map the networkIds to the network Objects. This function can be used to data-bind the sdk to the application.

Returns:

The key being the networkId and the value being the networkObject. NOTE: This HashMap is for read-only any misuse may cause the program to misbehave and even crash.

containsNetwork

public boolean containsNetwork(java.lang.String networkId)

internalAddNetwork

protected void internalAddNetwork(Network network)

internalRemoveNetwork

protected void internalRemoveNetwork(java.lang.String networkId)

clearNetworks

protected void clearNetworks()

getNetwork

public <T extends Network> T getNetwork(java.lang.String networkId)

setConnectivityMode

public void setConnectivityMode(CocoClient.ConnectivityMode mode)

sets the connectivity mode using Native method defined using JNI.

Parameters:

mode - CocoClient.ConnectivityMode

informNetworkChange

public void informNetworkChange()