Progress® Telerik® Reporting R2 2018

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.WebApi
Assembly:  Telerik.Reporting.Services.WebApi (in Telerik.Reporting.Services.WebApi.dll)

Syntax

public abstract class ReportsControllerBase : ApiController

The ReportsControllerBase type exposes the following members.

Constructors

  NameDescription
Protected methodReportsControllerBase
Initializes a new instance of the ReportsControllerBase class.
Top

Properties

  NameDescription
Public propertyCode exampleReportServiceConfiguration
Gets or sets the configuration of the report service.
Top

Methods

  NameDescription
Protected methodCreateCacheObsolete.
Creates an ICache implementation instance that will be used for internal storage from the service.
Public methodCreateDocument
Creates new document using specific format and format settings
Protected methodCreateErrorResponse
Creates error response to be sent to the client
Public methodCreateInstance
Creates a new report instance in a client session
Protected methodCreateReportResolverObsolete.
Creates an IReportResolver implementation instance that will be used for report resolving from the service
Protected methodCreateStorageObsolete.
Creates an IStorage implementation instance that will be used for internal storage from the service.
Public methodDeleteDocument
Deletes concrete document by its ID.
Public methodDeleteInstance
Deletes a report instance in a client session
Public methodExecuteInteractiveAction
Executes an interactive action that should be applied on the server
Public methodGetDocument
Gets the document for a single-stream document formats
Public methodGetDocumentFormats
Gets the available document formats.
Public methodGetDocumentInfo
Gets info for a requested document
Public methodGetPage
Gets a page from a document in a multi-stream document format
Public methodGetPageSettings
Gets the report page settings for a concrete client and report source
Public methodGetParameters
Gets the report parameters for a concrete client and report source
Protected methodGetReportInstanceKey
Utility method. Resolves an instance ID to a report key.
Public methodGetResource(String, String)
Gets an embedded report viewer resource.
Public methodGetResource(String, String, String, String)
Gets a resource part of a document in multi-stream document format
Public methodGetSearchResults
Retrieves the search metadata from resources and returns the search results that satisfy the passed arguments
Protected methodGetUserIdentity
Override this method to substitute the default UserIdentity retrieval logic, which uses System.Web.HttpContext.Current.User.Identity
Protected methodOnCreateDocument
Called when document is requested, before rendering the document.
Protected methodOnGetDocument
Called when document is requested, before sending the response.
Public methodRegisterClient
Registers new HTTP service client
Public methodUnregisterClient
Removes existing client of the HTTP service by its ID
Top

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.

See Also

Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy