SDK
SDK Java v2.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.

expire #

Sets a timeout (in seconds) on a key. After the timeout has expired, the key will automatically be deleted.

[Redis documentation]


expire(key, seconds, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
secondsintTime to live, in seconds
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.expire("key", 42, new ResponseListener<Boolean>() {
  @Override
  public void onSuccess(int status) {
    // callback called once the action has completed
  }
  @Override
  public void onError(JSONObject error) {
  }
});

Callback response:

true