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. All methods are available via Backendless.Cache.[methodname] accessor:

// synchronous methods
public void Put( String key, Object obj );
public void Put( String key, Object obj, int timeToLive );

// asynchronous methods
public void Put( String key, Object obj, AsyncCallback<Object> callback )
public void Put( String key, Object obj, int expire, AsyncCallback<Object> callback );

where:

• 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.
• callback - the callback used for asynchronous calls to indicate that the operation has either successfully completed or resulted in error.

Example

AsyncCallback<Object> callback = new AsyncCallback<Object>(
result =>
{
  System.Console.WriteLine( "object has been placed into cache" );
},
fault =>
{
  System.Console.WriteLine( "Error - " + fault );
} );

// putting string into cache
Backendless.Cache.Put( "foo", "hello world", callback );

// putting complex object into cache
Order order = Backendless.Persistence.Of<Order>().FindFirst();
Backendless.Cache.Put( "firstorder", order );

Codeless Reference

where:

Argument	Description
key name	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.
data	Value to place into cache, it can be a string, number, or any other valid JSON type.
time to live (in seconds)	Numeric value (in seconds) indicating how long the object must stay in cache before it expires. When an object expires, Backendless automatically removes it from cache. The default value is 7200 seconds.

This operation does not return a value.

The example below adds a new key-value pair into cache that will expire in 300 seconds.

The result of this operation will look as shown below after the Codeless logic runs: