Class OpenBiApiClientHostHeaderExtensions

Namespace

BiExcellence.OpenBi.Api.HostHeaders

Assembly

BiExcellence.OpenBi.Api.Client.dll

Extension methods for the /hostheaders REST API.

public static class OpenBiApiClientHostHeaderExtensions

Inheritance

object

OpenBiApiClientHostHeaderExtensions

Methods

CreateHostHeaderAsync(IOpenBiApiClient, HostHeader, CancellationToken)

Creates a host header and returns it as stored, including the server-assigned id. A caller that picks its own id can use UpdateHostHeaderAsync(IOpenBiApiClient, string, HostHeader, CancellationToken) instead, which creates as well. Takes effect without a restart.

public static Task<HostHeader?> CreateHostHeaderAsync(this IOpenBiApiClient client, HostHeader hostHeader, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

hostHeader HostHeader

cancellationToken CancellationToken

Returns

Task<HostHeader>

DeleteHostHeaderAsync(IOpenBiApiClient, string, CancellationToken)

Deletes a host header. Requests for that host name are then served by a wildcard host header ( or .domain) if one matches, and not by the CMS otherwise.

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

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task

GetHostHeaderAsync(IOpenBiApiClient, string, CancellationToken)

Reads one host header by id. Throws OpenBiApiException with status 404 when there is no host header with this id.

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

Parameters

client IOpenBiApiClient

id string

cancellationToken CancellationToken

Returns

Task<HostHeader>

GetHostHeadersAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists host headers (GET hostheaders), with the shared list options of request. Use QueryHostHeadersAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken) when a filter is too long for a URL.

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

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<HostHeader>>

QueryHostHeadersAsync(IOpenBiApiClient, OpenBiListRequest?, CancellationToken)

Lists host headers with the options in the request body instead of in the query string - the QUERY-method form of the list route, for filters that do not fit in a URL.

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

Parameters

client IOpenBiApiClient

request OpenBiListRequest

cancellationToken CancellationToken

Returns

Task<OpenBiListResult<HostHeader>>

UpdateHostHeaderAsync(IOpenBiApiClient, string, HostHeader, CancellationToken)

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

public static Task<HostHeader?> UpdateHostHeaderAsync(this IOpenBiApiClient client, string id, HostHeader hostHeader, CancellationToken cancellationToken = default)

Parameters

client IOpenBiApiClient

id string

hostHeader HostHeader

cancellationToken CancellationToken

Returns

Task<HostHeader>