Progress® Telerik® Reporting R3 2020
ReportsControllerBase Class
Base API controller for exposing a WebAPI to the report engine.
Inheritance Hierarchy
SystemObject
ApiController
Telerik.Reporting.Services.WebApiReportsControllerBase
Namespace:
Telerik.Reporting.Services.WebApiApiController
Telerik.Reporting.Services.WebApiReportsControllerBase
Assembly: Telerik.Reporting.Services.WebApi (in Telerik.Reporting.Services.WebApi.dll)
Syntax
The ReportsControllerBase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | ReportsControllerBase |
Initializes a new instance of the ReportsControllerBase class.
|
Properties
Name | Description | |
---|---|---|
![]() ![]() | ReportServiceConfiguration |
Gets or sets the configuration of the report service.
|
Methods
Name | Description | |
---|---|---|
![]() | CreateCache | Obsolete.
Creates an ICache implementation instance
that will be used for internal storage from the service.
|
![]() | CreateDocument |
Creates new document using specific format and format settings.
|
![]() | CreateErrorResponse |
Creates error response to be sent to the client
|
![]() | CreateInstance |
Creates a new report instance in a client session.
|
![]() | CreateMailMessage |
Creates the mail message that will be used in SendDocument
|
![]() | CreateReportResolver | Obsolete.
Creates an IReportResolver implementation instance
that will be used for report resolving from the service.
|
![]() | CreateStorage | Obsolete.
Creates an IStorage implementation instance
that will be used for internal storage from the service.
|
![]() | DeleteDocument |
Deletes concrete document by its ID.
|
![]() | DeleteInstance |
Deletes a report instance in a client session
|
![]() | ExecuteInteractiveAction |
Executes an interactive action that should be applied on the server.
|
![]() | GetDocument |
Gets the document for a single-stream document formats.
|
![]() | GetDocumentFormats |
Gets the available document formats.
|
![]() | GetDocumentInfo |
Gets info for a requested document.
|
![]() | GetPage |
Gets a page from a document in a multi-stream document format.
|
![]() | GetPageSettings |
Gets the report page settings for a concrete client and report source.
|
![]() | GetParameters |
Gets the report parameters for a concrete client and report source.
|
![]() | GetReportInstanceKey |
Utility method. Resolves an instance ID to a report key.
|
![]() | GetResource(String, String) |
Gets an embedded report viewer resource.
|
![]() | GetResource(String, String, String, String) |
Gets a resource part of a document in multi-stream document format.
|
![]() | GetSearchResults |
Retrieves the search metadata from resources and returns the search results that satisfy the passed arguments.
|
![]() | GetUserIdentity |
Override this method to substitute the default UserIdentity retrieval logic,
which uses System.Web.HttpContext.Current.User.Identity.
|
![]() | OnCreateDocument |
Called when document is requested, before rendering the document.
|
![]() | OnGetDocument |
Called when document is requested, before sending the response.
|
![]() | RegisterClient |
Registers new HTTP service client.
|
![]() | SendDocument |
Sends an e-mail message with attached document.
|
![]() ![]() | SendMailMessage |
Sends an e-mail message containing a report document to its recipients.
Override this method in order to effectively send the mail message.
|
![]() | UnregisterClient |
Removes existing client of the HTTP service by its ID.
|
Remarks
A call to the RegisterRoutes(HttpConfiguration) method
must be added to the WebApiConfig.Register method so that the controller actions are accessible
from the routing mechanisms of the ASP.Net WebAPI framework.
Version Information
Supported in: 1.0.1