Class OpenBiDownloadExtensions

Extensions for downloads.

Inheritance

object

OpenBiDownloadExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.Downloads

Assembly: BiExcellence.OpenBi.Api.Download.dll

Syntax

public static class OpenBiDownloadExtensions

Methods

AssignDownloadToUsergroupAsync(IOpenBiSession, string, string, CancellationToken)

Assigns a download to an usergroup.

Declaration

public static Task AssignDownloadToUsergroupAsync(this IOpenBiSession session, string downloadId, string usergroupId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	downloadId	The download id.
string	usergroupId	The usergroup id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateDownloadAsync(IOpenBiSession, IDownload, CancellationToken)

Creates or updates a download.

Declaration

public static Task CreateDownloadAsync(this IOpenBiSession session, IDownload download, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task

DeleteDownloadAsync(IOpenBiSession, IDownload, CancellationToken)

Deletes a download.

Declaration

public static Task DeleteDownloadAsync(this IOpenBiSession session, IDownload download, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task

DeleteDownloadAsync(IOpenBiSession, string, CancellationToken)

Deletes a download by id.

Declaration

public static Task DeleteDownloadAsync(this IOpenBiSession session, string downloadId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	downloadId	The download id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteDownloadsAsync(IOpenBiSession, IEnumerable<IDownload>, CancellationToken)

Deletes downloads.

Declaration

public static Task DeleteDownloadsAsync(this IOpenBiSession session, IEnumerable<IDownload> downloads, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IDownload>	downloads	The downloads.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteDownloadsAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes downloads by id.

Declaration

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

Parameters

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

Returns

Type	Description
Task

GetDownloadGroupsAsync(IOpenBiSession, CancellationToken)

Returns a distinct list of all download Groups.

Declaration

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

Parameters

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

Returns

Type	Description
Task<IList<string>>

GetDownloadsAsync(IOpenBiSession, CancellationToken)

Returns all downloads.

Declaration

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

Parameters

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

Returns

Type	Description
Task<IList<IDownload>>

RemoveDownloadFromUsergroupAsync(IOpenBiSession, string, string, CancellationToken)

Removes a download from an usergroup.

Declaration

public static Task RemoveDownloadFromUsergroupAsync(this IOpenBiSession session, string downloadId, string usergroupId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	downloadId	The download id.
string	usergroupId	The usergroup id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task