Namespace Reveal.Sdk.Data

Classes

The class used to represent Bearer (aka 'Token') authentication.

RVHeadersDataSourceCredentials

The class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources. When sending HTTP requests to get data for the data source, the specified headers will be included.

RVInMemoryData

Base class that can be used as a helper class to implement IRVInMemoryData, you need to provide the data as an object implementing IEnumerable of IEnumerable objects (each object representing a cell in the data), and the list of fields in the schema. Each row returned by the 'Data' enumerable must have the same number of elements indicated in the schema, the order must be respected and values must be returned in the same order specified in the schema returned.

RVInMemoryData<T>

In-memory data implementation that returns data from the IEnumerable object passed to the constructor, this is the recommended implementation of IRVInMemoryData to use in most of the use cases, as it's the simpler to use. The schema will be automatically calculated from the T data type.

RVUsernamePasswordDataSourceCredential

The class used to represent domain/user/password credentials, required to connect to all data bases (MS SQL, MySQL, etc) and some other data sources (REST API for example).

Interfaces

IRVAuthenticationProvider

The interface that must be implemented and registered when adding Reveal in Startup ConfigureServices. It returns credentials to be used when getting data from a given data source.

IRVDataProvider

The interface that must be implemented and returned in to return in-memory data for dashboards.

IRVDataSourceCredential

Base interface representing credentials to connect to a given data source

IRVDataSourceProvider

The interface that must be implemented and returned in to replace data sources when a dashboard is opened. See 'Replacing data sources' in the developer guide for more information.

IRVInMemoryData

The interface representing in-memory data to be returned by IRVInMemoryDataProvider, please note data is returned as an IEnumerable, so there's no need to have all data loaded in memory. You would probably use the default implementation for this interface: RVInMemoryData<T>

IRVInMemoryDataProvider

IRVObjectEncoder

Allows the encoding of information in DataSource or DataSourceItems, before returning those objects to the client. DataSource and DataSourceItems information is typically sent from the server to the client when editing a dashboard. Decoding should be done using an IRVDataSourceProvider implementation. Only supported for Database providers.

IRVObjectFilter

Allows filtering of 'objects' (DataSource and DataSourceItems) to be returned to the client. This makes it possible, for example, to avoid some tables or views to be seen when creating a Database data source. Only supported for Database providers.