C# Class jsreport.Client.ReportingService

jsreport API .net Wrapper
Inheritance: IReportingService
Datei anzeigen Open project: jsreport/net Class Usage Examples

Public Methods

Method Description
GetEnginesAsync ( ) : Task>

Request list of engines registered in jsreport server

GetRecipesAsync ( ) : Task>

Request list of recipes registered in jsreport server

GetServerVersionAsync ( ) : Task

Request jsreport package version

RenderAsync ( RenderRequest request, CancellationToken ct = default(CancellationToken) ) : Task

Overload for more sophisticated rendering.

RenderAsync ( object request, CancellationToken ct = default(CancellationToken) ) : Task

Specify comnpletely the rendering requests, see http://jsreport.net/learn/api for details

RenderAsync ( string templateShortid, object data, CancellationToken ct = default(CancellationToken) ) : Task

The simpliest rendering using template shortid and input data

RenderAsync ( string templateShortid, string jsonData, CancellationToken ct = default(CancellationToken) ) : Task

The simpliest rendering using template shortid and input data

RenderByNameAsync ( string templateName, object data, CancellationToken ct = newCancellationToken() ) : Task

The simpliest rendering using template name and input data

RenderByNameAsync ( string templateName, string jsonData, CancellationToken ct = newCancellationToken() ) : Task

The simpliest rendering using template name and input data

ReportingService ( string serviceUri ) : System
ReportingService ( string serviceUri, string username, string password ) : System

Protected Methods

Method Description
CreateClient ( ) : HttpClient

Private Methods

Method Description
ReportFromResponse ( HttpResponseMessage response ) : Task
ValidateAndSerializeRequest ( object request ) : string

Method Details

CreateClient() protected method

protected CreateClient ( ) : HttpClient
return System.Net.Http.HttpClient

GetEnginesAsync() public method

Request list of engines registered in jsreport server
public GetEnginesAsync ( ) : Task>
return Task>

GetRecipesAsync() public method

Request list of recipes registered in jsreport server
public GetRecipesAsync ( ) : Task>
return Task>

GetServerVersionAsync() public method

Request jsreport package version
public GetServerVersionAsync ( ) : Task
return Task

RenderAsync() public method

Overload for more sophisticated rendering.
public RenderAsync ( RenderRequest request, CancellationToken ct = default(CancellationToken) ) : Task
request RenderRequest ram name="request">Description of rendering process
ct CancellationToken
return Task

RenderAsync() public method

Specify comnpletely the rendering requests, see http://jsreport.net/learn/api for details
public RenderAsync ( object request, CancellationToken ct = default(CancellationToken) ) : Task
request object ram name="request">Description of rendering process
ct CancellationToken
return Task

RenderAsync() public method

The simpliest rendering using template shortid and input data
public RenderAsync ( string templateShortid, object data, CancellationToken ct = default(CancellationToken) ) : Task
templateShortid string template shortid can be taken from jsreport studio or from filename in jsreport embedded
data object any json serializable object
ct CancellationToken
return Task

RenderAsync() public method

The simpliest rendering using template shortid and input data
public RenderAsync ( string templateShortid, string jsonData, CancellationToken ct = default(CancellationToken) ) : Task
templateShortid string template shortid can be taken from jsreport studio or from filename in jsreport embedded
jsonData string any json string
ct CancellationToken
return Task

RenderByNameAsync() public method

The simpliest rendering using template name and input data
public RenderByNameAsync ( string templateName, object data, CancellationToken ct = newCancellationToken() ) : Task
templateName string template name
data object any json serializable object
ct CancellationToken
return Task

RenderByNameAsync() public method

The simpliest rendering using template name and input data
public RenderByNameAsync ( string templateName, string jsonData, CancellationToken ct = newCancellationToken() ) : Task
templateName string template shortid can be taken from jsreport studio or from filename in jsreport embedded
jsonData string any json string
ct CancellationToken
return Task

ReportingService() public method

public ReportingService ( string serviceUri ) : System
serviceUri string
return System

ReportingService() public method

public ReportingService ( string serviceUri, string username, string password ) : System
serviceUri string
username string
password string
return System