Warning : this plugin is dead.

This plugin was a kind of http calls native proxy with a cache on native side. Not very useful anymore.

This plugin is not maintained anymore and has been archived.

---

Webservices plugin allows you to call APIs and store results in a native cache. This native cache can be processed with the native side. It has options to decide which call should be stored or not and so on.

Usage on the web side

cobalt.ws.config({
	base : {
		url : "", 
		params : {}
	},
	defaultParameters:{
		type : "GET", //default to GET
		errorCallback : function( data, errir, concernedCall ){}
	}
});

cobalt.ws.call({
	url : "", //added to base.url if defined
	params :{},
	storageKey : "", //result will be saved at this key into storage
	successCallback : function( data, concernedCall ){}, //called at WS call end. 
	errorCallback : function( data, error, concernedCall ){}, // call on WS error
	cacheCallback : function( data, concernedCall ){},   //called if something into storageKey
	cacheError : function( error, concernedCall ){},   //called if error with storage
});

Examples :

cobalt.ws.config({
	base : {
		url : "http://api.myservice.com",
		params : { apiKey : "3455345dd" }
	},
	defaultParameters:{
		type : "POST",
		errorCallback : function( data, error, concernedCall ){
			cobalt.log('WS ERROR', error, data);
		}
	}
});

cobalt.ws.call({
	url : "getUser",
	params : {
                userId: 42
            },
	storageKey : "user:412",
	cacheCallback : function( data, concernedCall ){
		cobalt.log('latest user data was', data.user )	
	},
	successCallback : function( data, concernedCall ){
		cobalt.log('server user data is', data.user )
	}
})

cobalt.ws.call({
	storageKey : "user:412",
	cacheCallback : function( data, concernedCall ){
		if (data){
			cobalt.log('latest user data was', data.user )	
		}
	}
})

getting the cache result only :

User can also get the result form cache without calling server again like this :

cobalt.ws.call({
	storageKey : "user:412",
	cacheCallback : function( data, concernedCall ){
		cobalt.log('latest user data was', data.user )	
	},
	cacheError : function( error, concernedCall  ){
		cobalt.log('error retrieving user ', error )	
	}
})

In this case, native side sends a "onStorageResult" message (see above) with the data in storageKey.

If something went wrong and sendCacheResult was true, native sends this to the web :

{ type : "plugin", name : "webservices", action : "onStorageError", data : {
	callId : 2312,
	text : "" // the error detail as string, for example : "EMPTY", "NOT_FOUND" or "UNKNOWN_ERROR"
}}

native side processing :

processData

This parameter can be used to treat the data received from cache or the server before sending it back to the web. It can be usefull to filtering, sorting, or doing anything with the data before sending it back to the web.

A method named "treatData" on the native side should be overrided to filter or sort the data.

storeValue and storedValueForKey :

Cobalt is storing cache data into NSUserDefault on iOS and into SharedPreferences for Android. These two methods on the native side are overridable to change the way data is stored.

• storeValue takes the storageKey and the data and should store the data somewhere
• storedValueForKey takes the storageKey string as parameter and returns the data from somewhere

if data or storageKey is null, those functions are not called by the Cobalt plugin

clearStorage

If you want to clear storage cache you can call this on the web side

cobalt.ws.clearStorage()

This is what is sent underneath to the native plugin

{ type : "plugin", name : "webservices", action : "clearStorage"}

And, if you changed things in "storeValue" and "storedValueForKey", override the clearStorage method on the native side for your own storage location.

handleError

This method on the native side is overridable to change the way errors are handled.