Skip to content

Putting data into cache

This API request places the object into Backendless cache and maps it to the specified key. If the timeToLive argument is not set, the object will expire from cache in 2 hours from the time when it is put in cache.

Non-Blocking API

Backendless.Cache.put(key, obj, timeToLive)
 .then( function( result ) {
 })
 .catch( function( error ) {
 });

Blocking API

Backendless.Cache.putSync(key, obj, timeToLive);

where:

Argument                Description
key key assigned to the object to identify it in cache. The key is used to retrieve the object from cache or to check if the cache still contains the object.
obj object to place into cache.
timeToLive numeric value (in seconds) indicating how long the object must stay in cache before it is expires. When an object expires, Backendless automatically removes it from cache. The default value is 7200 seconds.

Example

var order = // retrieving an object is out of scope for the example

var successCallback = function( response ) {
  console.log( "object has been put into cache" );
};

var failureCallback = function( fault ) {
  console.log( "error - " + fault.message );
};

Backendless.Cache.put( "firstorder", order )
 .then( successCallback )
 .catch( failureCallback );