Class OpenBiApiClientWebFileExtensions

Namespace

BiExcellence.OpenBi.Api.WebFiles

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /webfilecontainers and /webfiles REST API.

public static class OpenBiApiClientWebFileExtensions

Inheritance

object

OpenBiApiClientWebFileExtensions

Methods

CreateWebFileContainerAsync(IOpenBiApiClient, WebFileContainer, CancellationToken)

Creates a web file container and returns it with its server-assigned id. The container starts empty; add files with CreateWebFileContainerFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken). A caller that picks its own id can use UpdateWebFileContainerAsync(IOpenBiApiClient, string, WebFileContainer, CancellationToken) instead, which creates as well as updates.

public static Task<WebFileContainer?> CreateWebFileContainerAsync(this IOpenBiApiClient client, WebFileContainer container, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

container WebFileContainer

cancellationToken CancellationToken

Returns

Task<WebFileContainer>

CreateWebFileContainerFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken)

Adds a file to the container containerId and returns it with its server-assigned id. The container id in the route wins over ContainerId. The server fills an empty ContentType from the path's extension and Creator and Modifier from the authenticated user, and stores a copy in the history. A caller that picks its own id can use UpdateWebFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken) instead, which creates as well as updates.

public static Task<WebFile?> CreateWebFileContainerFileAsync(this IOpenBiApiClient client, string containerId, WebFile webFile, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

containerId string

webFile WebFile

cancellationToken CancellationToken

Returns

Task<WebFile>

DeleteWebFileAsync(IOpenBiApiClient, string, CancellationToken)

Deletes a web file. Its history is kept. An id that does not exist is not an error.

public static Task DeleteWebFileAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

DeleteWebFileContainerAsync(IOpenBiApiClient, string, CancellationToken)

Deletes a web file container together with its web files; anything the CMS served from them stops resolving. An id that does not exist is not an error.

public static Task DeleteWebFileContainerAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetWebFileAsync(IOpenBiApiClient, string, CancellationToken)

Reads one web file including its content (GET webfiles/{id}). Throws an OpenBiApiException with status 404 when there is no web file with this id.

public static Task<WebFile> GetWebFileAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<WebFile>

GetWebFileContainerAsync(IOpenBiApiClient, string, CancellationToken)

Reads one web file container (GET webfilecontainers/{id}). Throws an OpenBiApiException with status 404 when there is no container with this id.

public static Task<WebFileContainer> GetWebFileContainerAsync(this IOpenBiApiClient client, string id, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<WebFileContainer>

GetWebFileContainerFilesAsync(IOpenBiApiClient, string, CancellationToken)

Lists the files in a container (GET webfilecontainers/{containerId}/webfiles). Content is omitted; fetch a single file via GetWebFileAsync(IOpenBiApiClient, string, CancellationToken) to retrieve it. GetWebFilesAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken) lists across every container instead.

public static Task<OpenBiListResult<WebFile>> GetWebFileContainerFilesAsync(this IOpenBiApiClient client, string containerId, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

containerId string

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<WebFile>>

GetWebFileContainersAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists web file containers. Web files are the assets the CMS serves - stylesheets, scripts, images, templates - grouped into containers; a container is the unit that gets deployed and transported.

public static Task<OpenBiListResult<WebFileContainer>> GetWebFileContainersAsync(this IOpenBiApiClient client, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<WebFileContainer>>

GetWebFileHistoryAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken)

Lists the saved versions of one web file, newest first (GET webfiles/{id}/history) - the audit trail and the rollback source. Content is omitted; fetch a single revision via GetWebFileHistoryRecordAsync(IOpenBiApiClient, long, CancellationToken) to retrieve it.

public static Task<OpenBiListResult<WebFileHistory>> GetWebFileHistoryAsync(this IOpenBiApiClient client, string id, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<WebFileHistory>>

GetWebFileHistoryRecordAsync(IOpenBiApiClient, long, CancellationToken)

Returns one revision including its content (GET webfilehistory/{historyId}) - post it back with UpdateWebFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken) to roll the file back to it. Throws an OpenBiApiException with status 404 when there is no history record with this id.

public static Task<WebFileHistory> GetWebFileHistoryRecordAsync(this IOpenBiApiClient client, long historyId, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

historyId long

cancellationToken CancellationToken

Returns

Task<WebFileHistory>

GetWebFilesAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists files across every container; filter by container to narrow it. Content is omitted; fetch a single file via GetWebFileAsync(IOpenBiApiClient, string, CancellationToken) to retrieve it.

public static Task<OpenBiListResult<WebFile>> GetWebFilesAsync(this IOpenBiApiClient client, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<WebFile>>

UpdateWebFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken)

Creates or updates the web file with this id (POST webfiles/{id}) - an id that does not exist yet is inserted. Every save stores a copy in the history (GetWebFileHistoryAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken)); posting a version's content back here rolls the file back to it. The server fills the same fields as CreateWebFileContainerFileAsync(IOpenBiApiClient, string, WebFile, CancellationToken) does.

public static Task<WebFile?> UpdateWebFileAsync(this IOpenBiApiClient client, string id, WebFile webFile, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

webFile WebFile

cancellationToken CancellationToken

Returns

Task<WebFile>

UpdateWebFileContainerAsync(IOpenBiApiClient, string, WebFileContainer, CancellationToken)

Creates or updates the web file container with this id (POST webfilecontainers/{id}) - an id that does not exist yet is inserted. The id in the route wins over the one in the body.

public static Task<WebFileContainer?> UpdateWebFileContainerAsync(this IOpenBiApiClient client, string id, WebFileContainer container, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

container WebFileContainer

cancellationToken CancellationToken

Returns

Task<WebFileContainer>