SDK
SDK Android v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

expireat #

Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted. The timestamp parameter accepts an Epoch time value.

[Redis documentation]


expireat(key, timestamp, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
timestampintExpiration timestamp
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns a boolean specifying if the operation was successful or not.

Usage #

kuzzle.memoryStorage.expireat("key", 1488372354, new ResponseListener<Boolean>() {
  @Override
  public void onSuccess(Boolean status) {
    // callback called once the action has completed
  }
  @Override
  public void onError(JSONObject error) {
  }
});

Callback response:

true