Class OpenBiConnectionTemplateExtensions

Extensions for connection templates.

Inheritance

object

OpenBiConnectionTemplateExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.ConnectionTemplates

Assembly: BiExcellence.OpenBi.Api.DataProvider.dll

Syntax

public static class OpenBiConnectionTemplateExtensions

Methods

CreateConnectionTemplateAsync(IOpenBiSession, IConnectionTemplate, CancellationToken)

Creates or updates a connection template.

Declaration

public static Task CreateConnectionTemplateAsync(this IOpenBiSession session, IConnectionTemplate connectionTemplate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IConnectionTemplate	connectionTemplate	The connection template.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteConnectionTemplateAsync(IOpenBiSession, IConnectionTemplate, CancellationToken)

Deletes a connection template.

Declaration

public static Task DeleteConnectionTemplateAsync(this IOpenBiSession session, IConnectionTemplate connectionTemplate, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IConnectionTemplate	connectionTemplate	The connection template.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteConnectionTemplateAsync(IOpenBiSession, string, CancellationToken)

Deletes a connection template by id.

Declaration

public static Task DeleteConnectionTemplateAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	id	The connection template id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteConnectionTemplatesAsync(IOpenBiSession, IEnumerable<IConnectionTemplate>, CancellationToken)

Deletes connection templates.

Declaration

public static Task DeleteConnectionTemplatesAsync(this IOpenBiSession session, IEnumerable<IConnectionTemplate> connectionTemplates, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IConnectionTemplate>	connectionTemplates	The connection templates.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteConnectionTemplatesAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes connection templates by id.

Declaration

public static Task DeleteConnectionTemplatesAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<string>	ids	The connection template ids.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

GetConnectionTemplatesAsync(IOpenBiSession, CancellationToken)

Returns all connection templates.

Declaration

public static Task<IList<IConnectionTemplate>> GetConnectionTemplatesAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IConnectionTemplate>>

GetConnectionTemplatesByTypeAsync(IOpenBiSession, string, CancellationToken)

Returns connection templates for a type.

Declaration

public static Task<IList<IConnectionTemplate>> GetConnectionTemplatesByTypeAsync(this IOpenBiSession session, string type, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	type	The type.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<IConnectionTemplate>>

GetDataProviderTypesAsync(IOpenBiSession, CancellationToken)

Returns all data provider types.

Declaration

public static Task<IList<IDataProviderType>> GetDataProviderTypesAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
CancellationToken	cancellationToken	The cancellationt token.

Returns

Type	Description
Task<IList<IDataProviderType>>