Interface IDownloadClient

Namespace: FastReport.Cloud

Assembly: FastReport.Cloud.SDK.dll

Syntax

public interface IDownloadClient

Methods

GetExport(String, Nullable<Boolean>)

Returns a export file with specified id

Declaration

FileResponse GetExport(string id, bool? preview = null)

Parameters

Type	Name	Description
System.String	id
System.Nullable<System.Boolean>	preview

Returns

Type	Description
FileResponse	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetExportAsync(String, Nullable<Boolean>, System.Threading.CancellationToken)

Returns a export file with specified id

Declaration

System.Threading.Tasks.Task<FileResponse> GetExportAsync(string id, bool? preview = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
System.Nullable<System.Boolean>	preview
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetExports(String, String, String)

Returns a zip archive with selected ids

Declaration

FileResponse GetExports(string archiveName, string fileIds = null, string folderIds = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign

Returns

Type	Description
FileResponse	Specified files was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetExportsAsync(String, String, String, System.Threading.CancellationToken)

Returns a zip archive with selected ids

Declaration

System.Threading.Tasks.Task<FileResponse> GetExportsAsync(string archiveName, string fileIds = null, string folderIds = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified files was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetExportThumbnail(String)

Returns export's thumbnail

Declaration

FileResponse GetExportThumbnail(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
FileResponse	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetExportThumbnailAsync(String, System.Threading.CancellationToken)

Returns export's thumbnail

Declaration

System.Threading.Tasks.Task<FileResponse> GetExportThumbnailAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetLastSVGExport(String)

returns export, that was created from report with specified id.
INTERNAL USAGE ONLY!

Declaration

FileResponse GetLastSVGExport(string reportId)

Parameters

Type	Name	Description
System.String	reportId

Returns

Type	Description
FileResponse	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetLastSVGExportAsync(String, System.Threading.CancellationToken)

returns export, that was created from report with specified id.
INTERNAL USAGE ONLY!

Declaration

System.Threading.Tasks.Task<FileResponse> GetLastSVGExportAsync(string reportId, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	reportId
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReport(String)

Returns a prepared file with specified id

Declaration

FileResponse GetReport(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
FileResponse	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReportAsync(String, System.Threading.CancellationToken)

Returns a prepared file with specified id

Declaration

System.Threading.Tasks.Task<FileResponse> GetReportAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReports(String, String, String)

Returns a zip archive with selected files

Declaration

FileResponse GetReports(string archiveName, string fileIds = null, string folderIds = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign

Returns

Type	Description
FileResponse	Files were downloaded

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReportsAsync(String, String, String, System.Threading.CancellationToken)

Returns a zip archive with selected files

Declaration

System.Threading.Tasks.Task<FileResponse> GetReportsAsync(string archiveName, string fileIds = null, string folderIds = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Files were downloaded

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReportThumbnail(String)

Returns report's thumbnail

Declaration

FileResponse GetReportThumbnail(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
FileResponse	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetReportThumbnailAsync(String, System.Threading.CancellationToken)

Returns report's thumbnail

Declaration

System.Threading.Tasks.Task<FileResponse> GetReportThumbnailAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplate(String)

Returns a Template file with specified id

Declaration

FileResponse GetTemplate(string id)

Parameters

Type	Name	Description
System.String	id	template id

Returns

Type	Description
FileResponse	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplateAsync(String, System.Threading.CancellationToken)

Returns a Template file with specified id

Declaration

System.Threading.Tasks.Task<FileResponse> GetTemplateAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	template id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified file was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplates(String, String, String)

Returns a zip archive with selected files

Declaration

FileResponse GetTemplates(string archiveName, string fileIds = null, string folderIds = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign

Returns

Type	Description
FileResponse	Files were downloaded

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplatesAsync(String, String, String, System.Threading.CancellationToken)

Returns a zip archive with selected files

Declaration

System.Threading.Tasks.Task<FileResponse> GetTemplatesAsync(string archiveName, string fileIds = null, string folderIds = null, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	archiveName	name of the created archive
System.String	fileIds	ids separated with a ',' sign
System.String	folderIds	ids separated with a ',' sign
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Files were downloaded

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplateThumbnail(String)

Returns template's thumbnail

Declaration

FileResponse GetTemplateThumbnail(string id)

Parameters

Type	Name	Description
System.String	id

Returns

Type	Description
FileResponse	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.

GetTemplateThumbnailAsync(String, System.Threading.CancellationToken)

Returns template's thumbnail

Declaration

System.Threading.Tasks.Task<FileResponse> GetTemplateThumbnailAsync(string id, System.Threading.CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<FileResponse>	Specified thumbnail was found

Exceptions

Type	Condition
ApiException	A server side error occurred.