@gooddata/gooddata-js
Version:
GoodData JavaScript SDK
34 lines (33 loc) • 1.21 kB
TypeScript
import { IExportConfig, IExportResponse } from "../interfaces";
import { XhrModule } from "../xhr";
import { IPollingOptions } from "../util";
/**
* Functions for working with reports
*
* @Class report
* @module report
*/
export declare class ReportModule {
private xhr;
constructor(xhr: XhrModule);
/**
* exportResult
* request new result export
* request new export of existing AFM execution
*
* @experimental
* @method exportResult
* @param {String} projectId GoodData projectId
* @param {String} executionResult report which should be exported
* @param {IExportConfig} exportConfig requested export options
* @param {Object} pollingOptions for polling (maxAttempts, pollStep)
* @return {Promise} Resolves if export successfully,
* Reject if export has error (network error, api error)
*/
exportResult(projectId: string, executionResult: string, exportConfig?: IExportConfig, pollingOptions?: IPollingOptions): Promise<IExportResponse>;
private sanitizeExportConfig;
private handleExportResultError;
private isApiResponseError;
private sanitizeFilters;
private sanitizeFilter;
}