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.

spop #

Removes and returns one or more elements at random from a set of unique values.

[Redis documentation]


spop(key, [options], [callback]) #

ArgumentsTypeDescription
keystringKey identifier
optionsJSON ObjectOptional parameters
callbackfunctionCallback

Options #

OptionTypeDescriptionDefault
countintNumber of elements to remove1
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the MemoryStorage object to allow chaining.


Callback Response #

Returns an array of removed elements.

Usage #

kuzzle.memoryStorage.spop("key", new ResponseListener<String[]>() {
  @Override
  public void onSuccess(String[] elements) {
    // callback called once the action has completed
  }
  @Override
  public void onError(JSONObject error) {
  }
});

Callback response:

["removed element"]