downloadReportDataChunkInSession() Method
In ReportService, use the downloadReportDataChunk() method to download very large documents using the bipSessionToken of a given user.
The caller calls this method multiple times until all document content is downloaded. Each call to this method downloads one chunk of the document, where the beginIdx parameter refers to the file download starting point.
For more information about in-session methods, see About In-Session Methods.
Signature
ReportDataChunk downloadReportDataChunkInSession(String fileID, int beginIdx, int size, String bipSessionToken);
Parameters for downloadReportDataChunkInSession() Method
| Parameter | Description |
|---|---|
|
String fileID |
fileID is returned inside ReportRequest, which is returned when calling runReport() Method. |
|
int beginIdx |
The starting point of the index (default is |
|
int size |
The size of the file to download (in kilobytes). |
|
String bipSessionToken |
The proprietary token string generated for the user. With the bipSessionToken string, the user no longer needs to provide user credentials. The server can validate this token string and restore the session to perform needed operation. |