Class OpenBiConfiguration

Represents the configuration for connecting to a server.

Inheritance

object

OpenBiConfiguration

Implements

• IOpenBiConfiguration

Namespace: BiExcellence.OpenBi.Api

Assembly: BiExcellence.OpenBi.Api.dll

Syntax

public class OpenBiConfiguration : IOpenBiConfiguration

Constructors

OpenBiConfiguration(Protocol, string, int, string?, string?, TimeSpan?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Protocol protocol, string host, int port, string? applicationName, string? cultureName, TimeSpan? requestTimeout)

Parameters

Type	Name	Description
Protocol	protocol	The server protocol.
string	host	The server host.
int	port	The server port.
string	applicationName	The application name.
string	cultureName	The culture name. Two letter ISO name.
TimeSpan?	requestTimeout	The default request timeout.

OpenBiConfiguration(Protocol, string, int, string?, string?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Protocol protocol, string host, int port, string? applicationName, string? cultureName)

Parameters

Type	Name	Description
Protocol	protocol	The server protocol.
string	host	The server host.
int	port	The server port.
string	applicationName	The application name.
string	cultureName	The culture name. Two letter ISO name.

OpenBiConfiguration(Protocol, string, int, string?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Protocol protocol, string host, int port, string? applicationName)

Parameters

Type	Name	Description
Protocol	protocol	The server protocol.
string	host	The server host.
int	port	The server port.
string	applicationName	The application name.

OpenBiConfiguration(Uri, string?, string?, TimeSpan?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Uri uri, string? applicationName, string? cultureName, TimeSpan? requestTimeout)

Parameters

Type	Name	Description
Uri	uri	The uri.
string	applicationName	The application name.
string	cultureName	The culture name. Two letter ISO name.
TimeSpan?	requestTimeout	The default request timeout.

OpenBiConfiguration(Uri, string?, string?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Uri uri, string? applicationName, string? cultureName)

Parameters

Type	Name	Description
Uri	uri	The uri.
string	applicationName	The application name.
string	cultureName	The culture name. Two letter ISO name.

OpenBiConfiguration(Uri, string?)

Initializes a new instance of the OpenBiConfiguration class.

Declaration

public OpenBiConfiguration(Uri uri, string? applicationName)

Parameters

Type	Name	Description
Uri	uri	The uri.
string	applicationName	The application name.

Properties

ApplicationName

Gets the application name.

Declaration

public string? ApplicationName { get; }

Property Value

Type	Description
string	The application name which is used in logging on the server.

CultureName

Gets the culture name.

Declaration

public string? CultureName { get; }

Property Value

Type	Description
string	The two letter culture name.

Host

Gets the host.

Declaration

public string Host { get; }

Property Value

Type	Description
string	The hostname or IP adress of the server.

Port

Gets the port.

Declaration

public int Port { get; }

Property Value

Type	Description
int	The port of the server.

Protocol

Gets the protocol.

Declaration

public Protocol Protocol { get; }

Property Value

Type	Description
Protocol	The protocol of the server.

RequestTimeout

Gets the request timeout.

Declaration

public TimeSpan? RequestTimeout { get; }

Property Value

Type	Description
TimeSpan?	The default request timeout. Use InfiniteTimeSpan to disable it.

Implements

• IOpenBiConfiguration

Extension Methods

• OpenBiConfigurationExtensions.ExecuteBatchJobUri(IOpenBiConfiguration)
• OpenBiConfigurationExtensions.ExecuteEventBatchJobUri(IOpenBiConfiguration)
• OpenBiConfigurationExtensions.ApiUri(IOpenBiConfiguration)
• OpenBiConfigurationExtensions.DownloadUri(IOpenBiConfiguration)
• OpenBiConfigurationExtensions.UploadUri(IOpenBiConfiguration)
• OpenBiConfigurationExtensions.Uri(IOpenBiConfiguration)
• Utils.FireEvent<T>(object, string, T)
• Utils.FireEvent<T>(object, string, object, T)