Interface IReportDesignerService

Interface for interacting with reports. Allows you to design and save WebReport

Namespace: FastReport.Web.Services

Assembly: FastReport.OpenSource.Web.dll

Syntax

public interface IReportDesignerService

Remarks

The interface may change over time

Methods

CreateReport(Stream, CancellationToken)

Asynchronously creates a report with provided report stream

Declaration

Task<string> CreateReport(Stream requestBody, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.IO.Stream	requestBody	Request body with report
System.Threading.CancellationToken	cancellationToken	Cancellation Token

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	WebReport Id

DesignerMakePreviewAsync(WebReport, Stream, CancellationToken)

Asynchronously returns a report preview string for Online Designer

Declaration

Task<string> DesignerMakePreviewAsync(WebReport webReport, Stream requestBody, CancellationToken cancellationToken)

Parameters

Type	Name	Description
WebReport	webReport	WebReport preview of which you want to return
System.IO.Stream	requestBody	Request body with report
System.Threading.CancellationToken	cancellationToken	Cancellation Token

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetDesignerReport(WebReport)

Returns the report for Online Designer

Declaration

string GetDesignerReport(WebReport webReport)

Parameters

Type	Name	Description
WebReport	webReport	WebReport to be displayed in the designer

Returns

Type	Description
System.String	Returns the report string for Online Designer

GetPOSTReportStringAsync(Stream, CancellationToken)

Asynchronously returns a string with the report

Declaration

Task<string> GetPOSTReportStringAsync(Stream requestBody, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.IO.Stream	requestBody	Request body with report
System.Threading.CancellationToken	cancellationToken	Cancellation Token

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	String with the report

SaveReportAsync(WebReport, SaveReportServiceParams, CancellationToken)

A method for saving the report

Declaration

Task<SaveReportResponseModel> SaveReportAsync(WebReport webReport, SaveReportServiceParams params, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
WebReport	webReport	Report to be saved
SaveReportServiceParams	params	Parameters for saving the report
System.Threading.CancellationToken	cancellationToken	Cancellation Token

Returns

Type	Description
System.Threading.Tasks.Task<SaveReportResponseModel>	Returns the object with the response