Class DownloadClient

Inheritance

System.Object

DownloadClient

Implements

IDownloadClient

Namespace: FastReport.Cloud.Client

Assembly: FastReport.Cloud.SDK.dll

Syntax

public class DownloadClient : object, IDownloadClient

Constructors

DownloadClient(System.Net.Http.HttpClient)

Declaration

public DownloadClient(System.Net.Http.HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

JsonSerializerSettings

Declaration

protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

PrepareRequestCallback

Declaration

public Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, string> PrepareRequestCallback { get; set; }

Property Value

Type	Description
Action<System.Net.Http.HttpClient, System.Net.Http.HttpRequestMessage, System.String>

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

GetExport(String, Nullable<Boolean>)

Returns a export file with specified id

Declaration

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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

public virtual 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

public virtual async 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.

ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage, System.Collections.Generic.IReadOnlyDictionary<String, System.Collections.Generic.IEnumerable<String>>, System.Threading.CancellationToken)

Declaration

protected virtual async System.Threading.Tasks.Task<DownloadClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(System.Net.Http.HttpResponseMessage response, System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IEnumerable<string>> headers, System.Threading.CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>	headers
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<DownloadClient.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

Implements

IDownloadClient