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.
- (void)putWithKey:(NSString * _Nonnull)key object:(id _Nonnull)object responseHandler:^(void)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;
- (void)putWithKey:(NSString * _Nonnull)key object:(id _Nonnull)object timeToLiveSec:(NSInteger)timeToLiveSec responseHandler:^(void)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;
func put(key: String, object: Any, responseHandler: (() -> Void)!, errorHandler: ((Fault) -> Void)!)
func put(key: String, object: Any, timeToLiveSec: Int, responseHandler: (() -> Void)!, errorHandler: ((Fault) -> Void)!)
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. |
object |
object to place into cache. |
timeToLiveSec |
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¶
Weather *weater = [Weather new];
[Backendless.shared.cache putWithKey:@"CacheWeather" object:weater timeToLiveSec:30 responseHandler:^{
NSLog(@"Object has been placed into cache");
} errorHandler:^(Fault *fault) {
NSLog(@"Error: %@", fault.message);
}];
let weather = Weather()
Backendless.shared.cache.put(key: "CacheWeather", object: weather, timeToLiveSec: 30, responseHandler: {
print("Object has been placed into cache")
}, errorHandler: { fault in
print("Error: \(fault.message ?? "")")
})
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:
