Class OpenBiDataProviderExtensions

Extension for data providers.

Inheritance

object

OpenBiDataProviderExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.DataProviders

Assembly: BiExcellence.OpenBi.Api.DataProvider.dll

Syntax

public static class OpenBiDataProviderExtensions

Methods

GetDataProvidersAsync(IOpenBiSession, IConnection, bool?, bool?, bool?, CancellationToken)

Returns a list of data providers for the connection.

Declaration

public static Task<IList<IDataProviderNode>> GetDataProvidersAsync(this IOpenBiSession session, IConnection connection, bool? withCombined = null, bool? withKpis = null, bool? withScorecards = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IConnection	connection	The connection.
bool?	withCombined	Include combined data providers.
bool?	withKpis	Incldue KPI data providers.
bool?	withScorecards	Include scorecard data providers.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IDataProviderNode>>

OpenDataProviderAsync(IOpenBiSession, IDataProvider, IConnectionTemplate, string?, CancellationToken)

Opens a data provider.

Declaration

public static Task<IUsedConnections> OpenDataProviderAsync(this IOpenBiSession session, IDataProvider dataProvider, IConnectionTemplate connectionTemplate, string? dataProviderName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IDataProvider	dataProvider	The data provider.
IConnectionTemplate	connectionTemplate	The connection template.
string	dataProviderName	The data provider name.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IUsedConnections>

OpenDataProviderAsync(IOpenBiSession, IDataProvider, IConnectionTemplate, CancellationToken)

Opens a data provider.

Declaration

public static Task<IUsedConnections> OpenDataProviderAsync(this IOpenBiSession session, IDataProvider dataProvider, IConnectionTemplate connectionTemplate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IDataProvider	dataProvider	The data provider.
IConnectionTemplate	connectionTemplate	The connection template.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IUsedConnections>