Class RevealSetupBuilder

Builder class used to register/build services that might be needed for Reveal.

Inheritance
System.Object
RevealSetupBuilder
Namespace: Reveal.Sdk
Assembly: Infragistics.Reveal.SDK.WebAPI.dll
Syntax
public class RevealSetupBuilder : Object

Constructors

RevealSetupBuilder()

Declaration
public RevealSetupBuilder()

Methods

AddAuthenticationProvider(IRVAuthenticationProvider)

Registers an authentication provider instance.

Declaration
public RevealSetupBuilder AddAuthenticationProvider(IRVAuthenticationProvider authenticationProvider)
Parameters
Type Name Description
IRVAuthenticationProvider authenticationProvider

The authentication provider instance to be used.

Returns
Type Description
RevealSetupBuilder

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 Description
RevealSetupBuilder
Type Parameters
Name Description
AuthenticationProvider

Type implementing IRVAuthenticationProvider interface.

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
Returns
Type Description
RevealSetupBuilder

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 Description
RevealSetupBuilder
Type Parameters
Name Description
DashboardProvider

Type implementing IRVDashboardProvider interface.

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
Type Description
RevealSetupBuilder

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 Description
RevealSetupBuilder
Type Parameters
Name Description
DataProvider

Type implementing IRVDataProvider interface.

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
Type Description
RevealSetupBuilder

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 Description
RevealSetupBuilder
Type Parameters
Name Description
DataSourceProvider

Type implementing IRVDataSourceProvider interface.

AddObjectEncoder(IRVObjectEncoder)

Declaration
public RevealSetupBuilder AddObjectEncoder(IRVObjectEncoder objectEncoder)
Parameters
Type Name Description
IRVObjectEncoder objectEncoder
Returns
Type Description
RevealSetupBuilder

AddObjectEncoder<ObjectEncoder>()

Declaration
public RevealSetupBuilder AddObjectEncoder<ObjectEncoder>()
    where ObjectEncoder : IRVObjectEncoder
Returns
Type Description
RevealSetupBuilder
Type Parameters
Name Description
ObjectEncoder

AddObjectFilter(IRVObjectFilter)

Declaration
public RevealSetupBuilder AddObjectFilter(IRVObjectFilter objectFilter)
Parameters
Type Name Description
IRVObjectFilter objectFilter
Returns
Type Description
RevealSetupBuilder

AddObjectFilter<ObjectFilter>()

Declaration
public RevealSetupBuilder AddObjectFilter<ObjectFilter>()
    where ObjectFilter : IRVObjectFilter
Returns
Type Description
RevealSetupBuilder
Type Parameters
Name Description
ObjectFilter

AddSettings(RevealEmbedSettings)

This allows you to provide settings.

Declaration
public RevealSetupBuilder AddSettings(RevealEmbedSettings settings)
Parameters
Type Name Description
RevealEmbedSettings settings

Settings object.

Returns
Type Description
RevealSetupBuilder
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
Type Description
RevealSetupBuilder
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
Type Name Description
IRVUserContextProvider userContextProvider

Type implementing IRVUserContextProvider interface.

Returns
Type Description
RevealSetupBuilder

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 Description
RevealSetupBuilder
Type Parameters
Name Description
UserContextProvider