Class OpenBiApiClientGridStyleExtensions

Namespace

BiExcellence.OpenBi.Api.GridStyles

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /gridstylegroups REST API.

public static class OpenBiApiClientGridStyleExtensions

Inheritance

object

OpenBiApiClientGridStyleExtensions

Methods

CreateGridStyleGroupAsync(IOpenBiApiClient, GridStyleGroup, CancellationToken)

Creates a grid style group and returns it as stored, including the server-assigned id. A caller that picks its own id can use UpdateGridStyleGroupAsync(IOpenBiApiClient, string, GridStyleGroup, CancellationToken) instead, which creates as well. The group is the container; its styles are written in one go with ReplaceGridStylesAsync(IOpenBiApiClient, string, GridStyle[], CancellationToken).

public static Task<GridStyleGroup?> CreateGridStyleGroupAsync(this IOpenBiApiClient client, GridStyleGroup group, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

group GridStyleGroup

cancellationToken CancellationToken

Returns

Task<GridStyleGroup>

DeleteGridStyleGroupAsync(IOpenBiApiClient, string, CancellationToken)

Deletes a grid style group. Its styles are deleted with it.

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

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetGridStyleGroupAsync(IOpenBiApiClient, string, CancellationToken)

Reads one grid style group by id. Throws OpenBiApiException with status 404 when there is no grid style group with this id.

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

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<GridStyleGroup>

GetGridStyleGroupsAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists grid style groups (GET gridstylegroups), with the shared list options of request. Their ids are what the document export of a data provider takes to pick the styling; the group with id default is used when none is given.

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

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<GridStyleGroup>>

GetGridStylesAsync(IOpenBiApiClient, string, OpenBiListRequest?, CancellationToken)

Lists all style rows of one grid style group, each naming the cell style it applies to. An unknown group id yields an empty list, not a 404.

public static Task<OpenBiListResult<GridStyle>> GetGridStylesAsync(this IOpenBiApiClient client, string groupId, OpenBiListRequest? request = null, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

groupId string

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<GridStyle>>

ReplaceGridStylesAsync(IOpenBiApiClient, string, GridStyle[], CancellationToken)

Replaces the full set of style rows for a grid style group in one transaction: rows not in rows are removed. The GroupId of each row is ignored and taken from groupId. Returns the stored rows.

public static Task<GridStyle[]> ReplaceGridStylesAsync(this IOpenBiApiClient client, string groupId, GridStyle[] rows, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

groupId string

rows GridStyle[]

cancellationToken CancellationToken

Returns

Task<GridStyle[]>

UpdateGridStyleGroupAsync(IOpenBiApiClient, string, GridStyleGroup, CancellationToken)

Creates or updates the grid style group with the given id: an id that is not there yet is inserted rather than answered with a 404.

public static Task<GridStyleGroup?> UpdateGridStyleGroupAsync(this IOpenBiApiClient client, string id, GridStyleGroup group, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

group GridStyleGroup

cancellationToken CancellationToken

Returns

Task<GridStyleGroup>