Class RVDashboardProvider

Default file system based implementation of Reveal.Sdk.IRVDashboardProvider loading/saving .rdash files from a specified(through the constructor) directory. If the dashboardId does not end with .rdash it will be added upon save and load.

Inheritance

System.Object

RVDashboardProvider

DefaultDashboardProvider

Implements

Reveal.Sdk.IRVDashboardProvider

Namespace: Reveal.Sdk

Assembly: Infragistics.Reveal.SDK.WebAPI.dll

Syntax

public class RVDashboardProvider : Object

Constructors

RVDashboardProvider(String)

Declaration

public RVDashboardProvider(string dashboardsDirectoryPath = "Dashboards")

Parameters

Type	Name	Description
System.String	dashboardsDirectoryPath	The directory to be used to load/save dashboards from/to.

Fields

_dashboardsDirectoryPath

Declaration

protected readonly string _dashboardsDirectoryPath

Field Value

Type	Description
System.String

_ext

Declaration

protected readonly string _ext

Field Value

Type	Description
System.String

DefaultDashboardsDirectoryPath

Declaration

public const string DefaultDashboardsDirectoryPath = "Dashboards"

Field Value

Type	Description
System.String

Methods

GetDashboardAsync(IRVUserContext, String)

Load dashboard from provided in the constructor location on the file system.

Declaration

public Task<Dashboard> GetDashboardAsync(IRVUserContext userContext, string dashboardId)

Parameters

Type	Name	Description
Reveal.Sdk.IRVUserContext	userContext	Object identifying the user.
System.String	dashboardId	The id of the requested dashboard.

Returns

Type	Description
System.Threading.Tasks.Task<Reveal.Sdk.Dashboard>

GetDashboardNotFoundErrorMessage(String)

Declaration

protected virtual string GetDashboardNotFoundErrorMessage(string dashboardId)

Parameters

Type	Name	Description
System.String	dashboardId

Returns

Type	Description
System.String

SaveDashboardAsync(IRVUserContext, String, Dashboard)

Saves a dashboard at the provided in the constructor location on the file system.

Declaration

public Task SaveDashboardAsync(IRVUserContext userContext, string dashboardId, Dashboard dashboard)

Parameters

Type	Name	Description
Reveal.Sdk.IRVUserContext	userContext	Object identifying the user.
System.String	dashboardId	The id of the requested dashboard.
Reveal.Sdk.Dashboard	dashboard	The dashboard to save.

Returns

Type	Description
System.Threading.Tasks.Task

Implements

Reveal.Sdk.IRVDashboardProvider