NuxeoDriveScrollDescendants (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.drive.operations.NuxeoDriveScrollDescendants

```
public class NuxeoDriveScrollDescendants
extends Object
```
Retrieves at most batchSize descendants of the FolderItem with the given id for the given scrollId.
When passing a null scrollId the initial search request is executed and the first batch of results is returned along with a scrollId which should be passed to the next call in order to retrieve the next batch of results.
Ideally, the search context made available by the initial search request is kept alive during keepAlive milliseconds if keepAlive is positive.
Results are not necessarily sorted.

Since:

8.3

Field Summary

Fields
Modifier and Type	Field	Description
`protected int`	`batchSize`
`protected OperationContext`	`ctx`
`protected String`	`id`
`static String`	`ID`
`protected long`	`keepAlive`
`protected String`	`scrollId`

Constructor Summary

Constructors
Constructor Description

NuxeoDriveScrollDescendants()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

Blob run()

protected Blob writeJSONBlob(ScrollFileSystemItemList scrollFSIList)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID
```
public static final String ID
```
See Also:

Constant Field Values

ctx
```
protected OperationContext ctx
```

id
```
protected String id
```

scrollId
```
protected String scrollId
```

batchSize
```
protected int batchSize
```

keepAlive
```
protected long keepAlive
```

Constructor Detail
- NuxeoDriveScrollDescendants
```
public NuxeoDriveScrollDescendants()
```

Method Detail

run

public Blob run()
         throws IOException

Throws:: IOException

writeJSONBlob

protected Blob writeJSONBlob(ScrollFileSystemItemList scrollFSIList)
                      throws IOException

Throws:: IOException