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.

scrollUsers #

Scrolls on stored users using the provided scroll ID.


scrollUsers(scrollId, [options], callback) #

ArgumentsTypeDescription
scrollIdstringScroll identifier retrieved from a search query
optionsJSON ObjectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns the list of fetched users according to the scroll parameters (offset, limit etc.).

Usage #

kuzzle
  .security
  .scrollUsers(scrollId, options, new ResponseListener<SecurityDocumentList>() {
    @Override
    public void onSuccess(SecurityDocumentList response) {
      // called once the scroll action has been completed
    }
    @Override
    public void onError(JSONObject error) {
      // Handle error
    }
  });