SDK Java v2.x

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) #

Arguments Type Description
scrollId string Scroll identifier retrieved from a search query
options JSON Object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

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

Usage #

Copied to clipboard!
  .scrollUsers(scrollId, options, new ResponseListener<SecurityDocumentList>() {
    public void onSuccess(SecurityDocumentList response) {
      // called once the scroll action has been completed
    public void onError(JSONObject error) {
      // Handle error