Telerik.Reporting.Services.WebApi
Creates a new instance of file cache in a temp folder that will store cached data.
The newly created cache instance.
Creates a new instance of file cache that will store cached data in a directory of the file system.
The directory path that will be used from the cache as repository.
The newly created cache instance.
Creates new instance of database cache that will store cached data in a database.
Specifies which database engine should be used.
A connection string that should be used to connect to the cache database
The newly created cache instance.
In order to use a database cache you should firstly use the Database Cache Configuration Tool
in order to create the underplaying database and its schema.
Note that the database cache implementation relies on the Telerik OpenAccess
so the following OpenAccess core libraries should be referenced: Telerik.OpenAccess.dll, Telerik.OpenAccess.35.Extensions.dll .
Proper assembly binding redirects might apply.
See also: Configuring the Database Cache Provider
Creates an instance from relative path to .trdx file
Base report resolver with fallback mechanism
Adds fallback resolver that will be used if the current resolver does not succeed.
The fallback resolver
Creates a based on its string representation.
The string report representation to resolve
The resulting report source
Creates a based on its string representation.
Override this member in order to implement the core resolve functionality.
The string report representation to resolve
The resulting report source
Initializes a new instance of the class.
Relative paths will be resolved against the application root.
Initializes a new instance of the class.
Physical directory where .trdx reports are located.
Used as path prefix when relative path is passed for resolving.
Creates a based on its string representation.
Accepts relative and absolute paths
The string report representation to resolve
The resulting report source
Resolves IReportDocument from report type name
Initializes a new instance of the class.
Creates a from a report type name.
Report type name
The resulting report source
Base API controller for exposing a WebAPI to the report engine
A call to the 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.
Initializes a new instance of the class.
Gets the available document formats.
Registers new HTTP service client
Removes existing client of the HTTP service by its ID
All cached data for the client will be cleared.
The ID of the client to be removed
Gets the report parameters for a concrete client and report source
The clientID for which the parameters are retrieved
The report source for which the parameters are retrieved
Creates a new report instance in a client session
The clientID for which the instance is created
The report source which defines the report instance
Utility method. Resolves an instance ID to a report key.
ReportInstanceKey if availble, otherwise null.
Deletes a report instance in a client session
The clientID for which the instance is deleted
The instanceID that is deleted
Creates new document using specific format and format settings
The clientID in which session the document is created
The report instance used for the document
Arguments containing the document format and settings
Deletes concrete document by its ID.
The client session ID which contains the deleted document
The report instance used for the document
The ID of the deleted document
Gets info for a requested document
The client session ID which contains the document
The report instance used for the document
The ID of the document
Gets the document for a single-stream document formats
The client session ID which contains the document
The report instance used for the document
The ID of the document
Gets a page from a document in a multi-stream document format
The client session ID which contains the document
The report instance used for the document
The ID of the document
The number of the requested page (1-based)
Gets a resource part of a document in multi-stream document format
The client session ID which contains the document
The report instance used for the document
The ID of the document
The ID of the requested resource
Executes an interactive action that should be applied on the server
The client session ID which contains the document
The report instance used for the document
The ID of the affected document
The ID of the executed action
Creates an implementation instance
that will be used for report resolving from the service
Override this method in order to create the report resolver instance.
May be one of the built-in report resolvers or a custom implementation resolver. Built-in resolvers may be chained.
Creates an implementation instance
that will be used for internal storage from the service.
Override this method in order to create the cache instance.
May be one of the built-in caching implementations or a custom implementation.
To use one of the built-in caching implementations use the class.
An instance of cache that will be used from the controller in order to preserve its cache/state.
Creates an implementation instance
that will be used for internal storage from the service.
Override this method in order to create the storage instance.
May be one of the built-in storage implementations or a custom implementation.
An instance of storage that will be used from the controller in order to preserve its cache/state.
Represents a report source passed to the ReportsControllerBase from its clients.
Gets or sets a string representation of a report document reference
The string representation should be of a or of an .
The rest of the report sources types are not supported.
Gets or sets a dictionary representing name-value pairs of parameter name and value passed to the reporting engine.
Represents the arguments passed to the CreateDocument method of the
The rendering format of the created document
See the full list of built-in formats in the help article
Rendering Extensions
Device setting for the specified format
More info on the device setting may be found in the help chapter
Device Information Settings
Determines if the returned document should be returned from cached resources if available.
Determines a base document from the cache that should service as interactivity blueprint.
Applicable only when UseCache=true.
Determines the server interactivity action that should be triggered over an existing document in order
to generate the new document.
Applicable only when BaseDocumentID is provided.