Interface 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.

Namespace: Reveal.Sdk
Assembly: Infragistics.Reveal.SDK.Server.dll
Syntax
public interface IRVObjectEncoder

Methods

Encode(IRVUserContext, RVDashboardDataSource)

Used to encode the information of a Datasource returned to the client. Only supported for Database providers.

Declaration
Task<RVDashboardDataSource> Encode(IRVUserContext userContext, RVDashboardDataSource dataSource)
Parameters
Type Name Description
IRVUserContext userContext

User context

RVDashboardDataSource dataSource

Information about the data source being used, like the host name for a database, etc.

Returns
Type Description
System.Threading.Tasks.Task<RVDashboardDataSource>

The new data source to use or null to use the original data source

Encode(IRVUserContext, RVDataSourceItem)

Used to encode the information of a DatasourceItem returned to the client. Only supported for Database providers.

Declaration
Task<RVDataSourceItem> Encode(IRVUserContext userContext, RVDataSourceItem dataSourceItem)
Parameters
Type Name Description
IRVUserContext userContext

User context

RVDataSourceItem dataSourceItem

Information about the data source item being used, like the name of the table, database, etc.

Returns
Type Description
System.Threading.Tasks.Task<RVDataSourceItem>

The new data source item to use or null to use the original data source item