340 lines
19 KiB
XML
340 lines
19 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Telerik.Reporting.Services.WebApi</name>
|
|
</assembly>
|
|
<members>
|
|
<!-- Badly formed XML comment ignored for member "T:Telerik.Reporting.Services.WebApi.CacheFactory" -->
|
|
<member name="M:Telerik.Reporting.Services.WebApi.CacheFactory.CreateFileCache">
|
|
<summary>
|
|
Creates a new instance of file cache in a temp folder that will store cached data.
|
|
</summary>
|
|
<returns>The newly created cache instance.</returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.CacheFactory.CreateFileCache(System.String)">
|
|
<summary>
|
|
Creates a new instance of file cache that will store cached data in a directory of the file system.
|
|
</summary>
|
|
<param name="directory">The directory path that will be used from the cache as repository.</param>
|
|
<returns>The newly created cache instance.</returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.CacheFactory.CreateDatabaseCache(System.String,System.String)">
|
|
<summary>
|
|
Creates new instance of database cache that will store cached data in a database.
|
|
</summary>
|
|
<param name="backendName">Specifies which database engine should be used.</param>
|
|
<param name="connectionString">A connection string that should be used to connect to the cache database</param>
|
|
<returns>The newly created cache instance.</returns>
|
|
<remarks>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.<br />
|
|
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.<br />
|
|
See also: <conceptualLink target="5f8e6a6f-1160-4d59-9554-fe3a14e2a286">Configuring the Database Cache Provider</conceptualLink></remarks>
|
|
</member>
|
|
<member name="T:Telerik.Reporting.Services.WebApi.ReportFileResolver">
|
|
<summary>
|
|
Creates an <see cref="T:Telerik.Reporting.UriReportSource"/> instance from relative path to .trdx file
|
|
</summary>
|
|
</member>
|
|
<member name="T:Telerik.Reporting.Services.WebApi.ReportResolverBase">
|
|
<summary>
|
|
Base report resolver with fallback mechanism
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportResolverBase.AddFallbackResolver(Telerik.Reporting.Services.Engine.IReportResolver)">
|
|
<summary>
|
|
Adds fallback resolver that will be used if the current resolver does not succeed.
|
|
</summary>
|
|
<param name="fallbackResolver">The fallback resolver</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportResolverBase.Telerik#Reporting#Services#Engine#IReportResolver#Resolve(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:Telerik.Reporting.ReportSource"/> based on its string representation.
|
|
</summary>
|
|
<param name="report">The string report representation to resolve</param>
|
|
<returns>The resulting report source</returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportResolverBase.ResolveReport(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:Telerik.Reporting.ReportSource"/> based on its string representation.
|
|
</summary>
|
|
<remarks>
|
|
Override this member in order to implement the core resolve functionality.
|
|
</remarks>
|
|
<param name="report">The string report representation to resolve</param>
|
|
<returns>The resulting report source</returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportFileResolver.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telerik.Reporting.Services.WebApi.ReportFileResolver"/> class.
|
|
Relative paths will be resolved against the application root.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportFileResolver.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telerik.Reporting.Services.WebApi.ReportFileResolver"/> class.
|
|
</summary>
|
|
<param name="repositoryDirectory">Physical directory where .trdx reports are located.
|
|
Used as path prefix when relative path is passed for resolving.</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportFileResolver.ResolveReport(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:Telerik.Reporting.UriReportSource"/> based on its string representation.
|
|
</summary>
|
|
<remarks>
|
|
Accepts relative and absolute paths
|
|
</remarks>
|
|
<param name="report">The string report representation to resolve</param>
|
|
<returns>The resulting report source</returns>
|
|
</member>
|
|
<member name="T:Telerik.Reporting.Services.WebApi.ReportTypeResolver">
|
|
<summary>
|
|
Resolves IReportDocument from report type name
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportTypeResolver.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telerik.Reporting.Services.WebApi.ReportTypeResolver"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportTypeResolver.ResolveReport(System.String)">
|
|
<summary>
|
|
Creates a <see cref="T:Telerik.Reporting.TypeReportSource"/> from a report type name.
|
|
</summary>
|
|
<param name="report">Report type name</param>
|
|
<returns>The resulting report source</returns>
|
|
</member>
|
|
<member name="T:Telerik.Reporting.Services.WebApi.ReportsControllerBase">
|
|
<summary>
|
|
Base API controller for exposing a WebAPI to the report engine
|
|
</summary>
|
|
<remarks>
|
|
A call to the <see cref="M:Telerik.Reporting.Services.WebApi.ReportsControllerConfiguration.RegisterRoutes(System.Web.Http.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.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Telerik.Reporting.Services.WebApi.ReportsControllerBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetDocumentFormats">
|
|
<summary>
|
|
Gets the available document formats.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.RegisterClient">
|
|
<summary>
|
|
Registers new HTTP service client
|
|
</summary>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.UnregisterClient(System.String)">
|
|
<summary>
|
|
Removes existing client of the HTTP service by its ID
|
|
</summary>
|
|
<remarks>
|
|
All cached data for the client will be cleared.
|
|
</remarks>
|
|
<param name="clientID">The ID of the client to be removed</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetParameters(System.String,Telerik.Reporting.Services.WebApi.ClientReportSource)">
|
|
<summary>
|
|
Gets the report parameters for a concrete client and report source
|
|
</summary>
|
|
<param name="clientID">The clientID for which the parameters are retrieved</param>
|
|
<param name="reportSource">The report source for which the parameters are retrieved</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.CreateInstance(System.String,Telerik.Reporting.Services.WebApi.ClientReportSource)">
|
|
<summary>
|
|
Creates a new report instance in a client session
|
|
</summary>
|
|
<param name="clientID">The clientID for which the instance is created</param>
|
|
<param name="reportSource">The report source which defines the report instance</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetReportInstanceKey(System.String)">
|
|
<summary>
|
|
Utility method. Resolves an instance ID to a report key.
|
|
</summary>
|
|
<returns>
|
|
ReportInstanceKey if availble, otherwise null.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.DeleteInstance(System.String,System.String)">
|
|
<summary>
|
|
Deletes a report instance in a client session
|
|
</summary>
|
|
<param name="clientID">The clientID for which the instance is deleted</param>
|
|
<param name="instanceID">The instanceID that is deleted</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.CreateDocument(System.String,System.String,Telerik.Reporting.Services.WebApi.CreateDocumentArgs)">
|
|
<summary>
|
|
Creates new document using specific format and format settings
|
|
</summary>
|
|
<param name="clientID">The clientID in which session the document is created</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="args">Arguments containing the document format and settings</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.DeleteDocument(System.String,System.String,System.String)">
|
|
<summary>
|
|
Deletes concrete document by its ID.
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the deleted document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the deleted document</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetDocumentInfo(System.String,System.String,System.String)">
|
|
<summary>
|
|
Gets info for a requested document
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the document</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetDocument(System.String,System.String,System.String)">
|
|
<summary>
|
|
Gets the document for a single-stream document formats
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the document</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetPage(System.String,System.String,System.String,System.Int32)">
|
|
<summary>
|
|
Gets a page from a document in a multi-stream document format
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the document</param>
|
|
<param name="pageNumber">The number of the requested page (1-based)</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.GetResource(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Gets a resource part of a document in multi-stream document format
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the document</param>
|
|
<param name="resourceID">The ID of the requested resource</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.ExecuteInteractiveAction(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Executes an interactive action that should be applied on the server
|
|
</summary>
|
|
<param name="clientID">The client session ID which contains the document</param>
|
|
<param name="instanceID">The report instance used for the document</param>
|
|
<param name="documentID">The ID of the affected document</param>
|
|
<param name="actionID">The ID of the executed action</param>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.CreateReportResolver">
|
|
<summary>
|
|
Creates an <see cref="T:Telerik.Reporting.Services.Engine.IReportResolver"/> implementation instance
|
|
that will be used for report resolving from the service
|
|
</summary>
|
|
<remarks>
|
|
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.
|
|
</remarks>
|
|
<seealso cref="T:Telerik.Reporting.Services.Engine.IReportResolver"/>
|
|
<seealso cref="T:Telerik.Reporting.Services.WebApi.ReportFileResolver"/>
|
|
<seealso cref="T:Telerik.Reporting.Services.WebApi.ReportTypeResolver"/>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.CreateCache">
|
|
<summary>
|
|
Creates an <see cref="T:Telerik.Reporting.Cache.Interfaces.ICache"/> implementation instance
|
|
that will be used for internal storage from the service.
|
|
</summary>
|
|
<remarks>
|
|
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 <seealso cref="T:Telerik.Reporting.Services.WebApi.CacheFactory"/> class.
|
|
</remarks>
|
|
<returns>An instance of cache that will be used from the controller in order to preserve its cache/state.</returns>
|
|
<seealso cref="T:Telerik.Reporting.Services.WebApi.CacheFactory"/>
|
|
</member>
|
|
<member name="M:Telerik.Reporting.Services.WebApi.ReportsControllerBase.CreateStorage">
|
|
<summary>
|
|
Creates an <see cref="T:Telerik.Reporting.Cache.Interfaces.IStorage"/> implementation instance
|
|
that will be used for internal storage from the service.
|
|
</summary>
|
|
<remarks>
|
|
Override this method in order to create the storage instance.
|
|
May be one of the built-in storage implementations or a custom implementation.
|
|
<seealso cref="T:Telerik.Reporting.Cache.MsSqlServerStorage"/>
|
|
<seealso cref="T:Telerik.Reporting.Cache.StackExchangeRedis.RedisStorage"/>
|
|
</remarks>
|
|
<returns>An instance of storage that will be used from the controller in order to preserve its cache/state.</returns>
|
|
<seealso cref="T:Telerik.Reporting.Services.WebApi.CacheFactory"/>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "P:Telerik.Reporting.Services.WebApi.ReportsControllerBase.ReportServiceConfiguration" -->
|
|
<member name="T:Telerik.Reporting.Services.WebApi.ClientReportSource">
|
|
<summary>
|
|
Represents a report source passed to the ReportsControllerBase from its clients.
|
|
</summary>
|
|
<seealso cref="T:Telerik.Reporting.ReportSource"/>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.ClientReportSource.Report">
|
|
<summary>
|
|
Gets or sets a string representation of a report document reference
|
|
</summary>
|
|
<remarks>
|
|
The string representation should be of a <see cref="T:Telerik.Reporting.TypeReportSource"/> or of an <see cref="T:Telerik.Reporting.UriReportSource"/>.
|
|
The rest of the report sources types are not supported.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.ClientReportSource.ParameterValues">
|
|
<summary>
|
|
Gets or sets a dictionary representing name-value pairs of parameter name and value passed to the reporting engine.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Telerik.Reporting.Services.WebApi.CreateDocumentArgs">
|
|
<summary>
|
|
Represents the arguments passed to the CreateDocument method of the <see cref="T:Telerik.Reporting.Services.WebApi.ReportsControllerBase"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.CreateDocumentArgs.Format">
|
|
<summary>
|
|
The rendering format of the created document
|
|
</summary>
|
|
<remarks>
|
|
See the full list of built-in formats in the help article
|
|
<conceptualLink target="935C2C81-69FB-4EE7-B104-C317A615D294">Rendering Extensions</conceptualLink>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.CreateDocumentArgs.DeviceInfo">
|
|
<summary>
|
|
Device setting for the specified format
|
|
</summary>
|
|
<remarks>
|
|
More info on the device setting may be found in the help chapter
|
|
<conceptualLink target="7B7459C1-F91D-4220-BC72-68804CD6B554">Device Information Settings</conceptualLink>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.CreateDocumentArgs.UseCache">
|
|
<summary>
|
|
Determines if the returned document should be returned from cached resources if available.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.CreateDocumentArgs.BaseDocumentID">
|
|
<summary>
|
|
Determines a base document from the cache that should service as interactivity blueprint.
|
|
</summary>
|
|
<remarks>
|
|
Applicable only when UseCache=true.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Telerik.Reporting.Services.WebApi.CreateDocumentArgs.ActionID">
|
|
<summary>
|
|
Determines the server interactivity action that should be triggered over an existing document in order
|
|
to generate the new document.
|
|
</summary>
|
|
<remarks>
|
|
Applicable only when BaseDocumentID is provided.
|
|
</remarks>
|
|
</member>
|
|
</members>
|
|
</doc>
|