Class OpenBiHostHeaderExtensions

Extension methods for host headers.

Inheritance

object

OpenBiHostHeaderExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.HostHeaders

Assembly: BiExcellence.OpenBi.Api.HostHeader.dll

Syntax

public static class OpenBiHostHeaderExtensions

Methods

CreateHostHeaderAsync(IOpenBiSession, IHostHeader, CancellationToken)

Creates or updates a host header.

Declaration

public static Task CreateHostHeaderAsync(this IOpenBiSession session, IHostHeader hostHeader, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IHostHeader	hostHeader	The host header.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHostHeaderAsync(IOpenBiSession, IHostHeader, CancellationToken)

Deletes a host header.

Declaration

public static Task DeleteHostHeaderAsync(this IOpenBiSession session, IHostHeader hostHeader, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IHostHeader	hostHeader	The host header.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHostHeaderAsync(IOpenBiSession, string, CancellationToken)

Deletes a host header by its id.

Declaration

public static Task DeleteHostHeaderAsync(this IOpenBiSession session, string hostHeaderId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	hostHeaderId	The host header id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHostHeadersAsync(IOpenBiSession, IEnumerable<IHostHeader>, CancellationToken)

Deletes host headers.

Declaration

public static Task DeleteHostHeadersAsync(this IOpenBiSession session, IEnumerable<IHostHeader> hostHeaders, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IEnumerable<IHostHeader>	hostHeaders	The host headers.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHostHeadersAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes host headers by ids.

Declaration

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

Parameters

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

Returns

Type	Description
Task

GetHostHeaders(IOpenBiSession)

Returns all host headers.

Declaration

public static IListRequest<IHostHeader> GetHostHeaders(this IOpenBiSession session)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.

Returns

Type	Description
IListRequest<IHostHeader>