Interface IReportService

Interface for interacting with reports. Allows you to preview and search WebReport

Namespace: FastReport.Web.Services

Assembly: FastReport.OpenSource.Web.dll

Syntax

public interface IReportService

Remarks

The interface may change over time

Methods

GetReportAsync(WebReport, GetReportServiceParams, CancellationToken)

Asynchronously returns a report for Preview on the Web

Declaration

Task<string> GetReportAsync(WebReport webReport, GetReportServiceParams params, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
WebReport	webReport	Report a preview of which you want to create
GetReportServiceParams	params	Report preview creation options
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Returns the HTML string of the report preview

InvokeCustomElementAction(WebReport, String, String)

Returns the report after clicking on an element with id = elementId

Declaration

Task<string> InvokeCustomElementAction(WebReport webReport, string elementId, string inputValue)

Parameters

Type	Name	Description
WebReport	webReport	Report to which the action applies
System.String	elementId	ID of the clicked item
System.String	inputValue

Returns

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

Touch(String)

Touches the report to reset its sliding expiration in the cache.

Declaration

bool Touch(string reportId)

Parameters

Type	Name	Description
System.String	reportId	The unique identifier of the report.

Returns

Type	Description
System.Boolean	true if a report with the provided ID was found; otherwise, false.

TryFindWebReport(String, out WebReport)

Finds the report by ID

Declaration

bool TryFindWebReport(string reportId, out WebReport webReport)

Parameters

Type	Name	Description
System.String	reportId	The ID of the report you want to find
WebReport	webReport	Found report

Returns

Type	Description
System.Boolean	WebReport