Class RevealSetupBuilder
Builder class used to register/build services that might be needed for Reveal.
Inheritance
System.Object
RevealSetupBuilder
Assembly: Infragistics.Reveal.SDK.WebAPI.dll
Syntax
public class RevealSetupBuilder : Object
Constructors
RevealSetupBuilder()
Declaration
public RevealSetupBuilder()
Properties
DataSources
Declaration
public IDataSourceRegistry DataSources { get; }
Property Value
| Type |
Description |
| Reveal.Engine.Api.IDataSourceRegistry |
|
Methods
AddAuthenticationProvider(IRVAuthenticationProvider)
Registers an authentication provider instance.
Declaration
public RevealSetupBuilder AddAuthenticationProvider(IRVAuthenticationProvider authenticationProvider)
Parameters
Returns
AddAuthenticationProvider<AuthenticationProvider>()
Registers an authentication provider type. It would be added to the asp DI framework so you could inject other services through the constructor.
Declaration
public RevealSetupBuilder AddAuthenticationProvider<AuthenticationProvider>()
where AuthenticationProvider : IRVAuthenticationProvider
Returns
Type Parameters
| Name |
Description |
| AuthenticationProvider |
Type implementing interface.
|
AddCredentialCatalog<T>()
Declaration
public RevealSetupBuilder AddCredentialCatalog<T>()
where T : ICredentialCatalog
Returns
Type Parameters
AddCredentialsResolver<T>()
Declaration
public RevealSetupBuilder AddCredentialsResolver<T>()
where T : ICredentialResolver
Returns
Type Parameters
AddDashboardProvider(IRVDashboardProvider)
Registers a data provider instance. It would be added to the asp DI framework.
Declaration
public RevealSetupBuilder AddDashboardProvider(IRVDashboardProvider dashboardProvider)
Parameters
| Type |
Name |
Description |
| IRVDashboardProvider |
dashboardProvider |
The dashboard provider instance to be registered.
|
Returns
AddDashboardProvider<DashboardProvider>()
Registers a DashboardProvider type. It would be added to the asp DI framework so you could inject other services through the constructor.
Declaration
public RevealSetupBuilder AddDashboardProvider<DashboardProvider>()
where DashboardProvider : IRVDashboardProvider
Returns
Type Parameters
AddDataProvider(IRVDataProvider)
Registers a data provider instance. It would be added to the asp DI framework.
Declaration
public RevealSetupBuilder AddDataProvider(IRVDataProvider dataProvider)
Parameters
| Type |
Name |
Description |
| IRVDataProvider |
dataProvider |
The data provider instance to be registered.
|
Returns
AddDataProvider<DataProvider>()
Registers a data provider type. It would be added to the asp DI framework so you could inject other services through the constructor.
Declaration
public RevealSetupBuilder AddDataProvider<DataProvider>()
where DataProvider : IRVDataProvider
Returns
Type Parameters
| Name |
Description |
| DataProvider |
Type implementing interface.
|
AddDataSourceCatalog<T>()
Declaration
public RevealSetupBuilder AddDataSourceCatalog<T>()
where T : IDataSourceCatalog
Returns
Type Parameters
AddDataSourceCatalogSelectionReader<T>()
Declaration
public RevealSetupBuilder AddDataSourceCatalogSelectionReader<T>()
where T : IDataSourceCatalogSelectionReader
Returns
Type Parameters
AddDataSourceItemPreProcessor<T>()
Declaration
public RevealSetupBuilder AddDataSourceItemPreProcessor<T>()
where T : IDataSourceItemPreProcessor
Returns
Type Parameters
AddDataSourceProvider(IRVDataSourceProvider)
Registers a data source provider instance.
Declaration
public RevealSetupBuilder AddDataSourceProvider(IRVDataSourceProvider dataSourceProvider)
Parameters
| Type |
Name |
Description |
| IRVDataSourceProvider |
dataSourceProvider |
The datasource provider instance to be used.
|
Returns
AddDataSourceProvider<DataSourceProvider>()
Registers a data source provider type. It would be added to the asp DI framework so you could inject other services through the constructor.
Declaration
public RevealSetupBuilder AddDataSourceProvider<DataSourceProvider>()
where DataSourceProvider : IRVDataSourceProvider
Returns
Type Parameters
| Name |
Description |
| DataSourceProvider |
Type implementing interface.
|
AddDataSourceResolver<T>()
Declaration
public RevealSetupBuilder AddDataSourceResolver<T>()
where T : IDataSourceResolver
Returns
Type Parameters
AddObjectEncoder(IRVObjectEncoder)
Declaration
public RevealSetupBuilder AddObjectEncoder(IRVObjectEncoder objectEncoder)
Parameters
Returns
AddObjectEncoder<ObjectEncoder>()
Declaration
public RevealSetupBuilder AddObjectEncoder<ObjectEncoder>()
where ObjectEncoder : IRVObjectEncoder
Returns
Type Parameters
| Name |
Description |
| ObjectEncoder |
|
AddObjectFilter(IRVObjectFilter)
Declaration
public RevealSetupBuilder AddObjectFilter(IRVObjectFilter objectFilter)
Parameters
Returns
AddObjectFilter<ObjectFilter>()
Declaration
public RevealSetupBuilder AddObjectFilter<ObjectFilter>()
where ObjectFilter : IRVObjectFilter
Returns
Type Parameters
| Name |
Description |
| ObjectFilter |
|
AddSettings(RevealEmbedSettings)
This allows you to provide settings.
Declaration
public RevealSetupBuilder AddSettings(RevealEmbedSettings settings)
Parameters
Returns
Examples
public void ConfigureServices(IServiceCollection services)
{
...
services
.AddMvc()
.AddReveal(builder =>
{
builder
.AddSettings(new RevealEmbedSettings()
{
LocalFileStoragePath = "Data",
DataCachePath = cacheFilePath,
CachePath = cacheFilePath
});
});
...
}
AddSettings(Action<RevealEmbedSettings>)
This allows you to change some of the default settings.
Declaration
public RevealSetupBuilder AddSettings(Action<RevealEmbedSettings> setupAction)
Parameters
| Type |
Name |
Description |
| System.Action<RevealEmbedSettings> |
setupAction |
Action that accepts a settings object you could update.
|
Returns
Examples
public void ConfigureServices(IServiceCollection services)
{
...
services
.AddMvc()
.AddReveal(builder =>
{
builder
.AddSettings(settings =>
{
settings.LocalFileStoragePath = "Data";
settings.DataCachePath = cacheFilePath;
settings.CachePath = cacheFilePath;
});
});
...
}
AddUserContextProvider(IRVUserContextProvider)
Registers an UserContextProvider type. It would be added to the asp DI framework so you could inject other services through the constructor.
Declaration
public RevealSetupBuilder AddUserContextProvider(IRVUserContextProvider userContextProvider)
Parameters
Returns
AddUserContextProvider<UserContextProvider>()
Registers a user context instance. It would be added to the asp DI framework.
Declaration
public RevealSetupBuilder AddUserContextProvider<UserContextProvider>()
where UserContextProvider : IRVUserContextProvider
Returns
Type Parameters
| Name |
Description |
| UserContextProvider |
|