Class OpenBiPingExtensions

Extension methods for ping and session information.

Inheritance

object

OpenBiPingExtensions

Namespace: BiExcellence.OpenBi.Api.Commands

Assembly: BiExcellence.OpenBi.Api.dll

Syntax

public static class OpenBiPingExtensions

Methods

GetSessionInformationAsync(IOpenBiSession, CancellationToken)

Returns the session information about the loggedin user

Declaration

public static Task<ISessionInfo> GetSessionInformationAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	the session
CancellationToken	cancellationToken	the cancellation token used for the request

Returns

Type	Description
Task<ISessionInfo>	Information about the user session.

PingAsync(IOpenBiSession, CancellationToken)

Pings the server (good to keep the IOpenBiSession alive).

Declaration

public static Task<IPingInfo> PingAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<IPingInfo>	Information about server version and session handle.