C# Class DocRaptor.Client.Configuration

Represents a set of configuration settings
ファイルを表示 Open project: DocRaptor/docraptor-csharp Class Usage Examples

Public Properties

Property Type Description
ApiClient ApiClient
ApiKey String>.Dictionary
ApiKeyPrefix String>.Dictionary
Default Configuration

Public Methods

Method Description
AddDefaultHeader ( string key, string value ) : void

Add default header.
Configuration ( ApiClient apiClient ) : System

Initializes a new instance of the Configuration class.
Configuration ( ApiClient apiClient = null, String>.Dictionary defaultHeader = null, string username = null, string password = null, string accessToken = null, String>.Dictionary apiKey = null, String>.Dictionary apiKeyPrefix = null, string tempFolderPath = null, string dateTimeFormat = null, int timeout = 100000 ) : System

Initializes a new instance of the Configuration class with different settings
GetApiKeyWithPrefix ( string apiKeyIdentifier ) : string

Get the API key with prefix.
ToDebugReport ( ) : String

Returns a string with essential information for debugging.
setApiClientUsingDefault ( ApiClient apiClient = null ) : void

Set the ApiClient using Default or ApiClient instance.

Method Details

AddDefaultHeader() public method

Add default header.
public AddDefaultHeader ( string key, string value ) : void
key string Header field name.
value string Header field value.
return void

Configuration() public method

Initializes a new instance of the Configuration class.
public Configuration ( ApiClient apiClient ) : System
apiClient ApiClient Api client.
return System

Configuration() public method

Initializes a new instance of the Configuration class with different settings
public Configuration ( ApiClient apiClient = null, String>.Dictionary defaultHeader = null, string username = null, string password = null, string accessToken = null, String>.Dictionary apiKey = null, String>.Dictionary apiKeyPrefix = null, string tempFolderPath = null, string dateTimeFormat = null, int timeout = 100000 ) : System
apiClient ApiClient Api client
defaultHeader String>.Dictionary Dictionary of default HTTP header
username string Username
password string Password
accessToken string accessToken
apiKey String>.Dictionary Dictionary of API key
apiKeyPrefix String>.Dictionary Dictionary of API key prefix
tempFolderPath string Temp folder path
dateTimeFormat string DateTime format string
timeout int HTTP connection timeout (in milliseconds)
return System

GetApiKeyWithPrefix() public method

Get the API key with prefix.
public GetApiKeyWithPrefix ( string apiKeyIdentifier ) : string
apiKeyIdentifier string API key identifier (authentication scheme).
return string

ToDebugReport() public static method

Returns a string with essential information for debugging.
public static ToDebugReport ( ) : String
return String

setApiClientUsingDefault() public method

Set the ApiClient using Default or ApiClient instance.
public setApiClientUsingDefault ( ApiClient apiClient = null ) : void
apiClient ApiClient An instance of ApiClient.
return void

Property Details

ApiClient public_oe property

Gets or sets the default API client for making HTTP calls.
public ApiClient,DocRaptor.Client ApiClient
return ApiClient

ApiKey public_oe property

Gets or sets the API key based on the authentication name.
public Dictionary ApiKey
return String>.Dictionary

ApiKeyPrefix public_oe property

Gets or sets the prefix (e.g. Token) of the API key based on the authentication name.
public Dictionary ApiKeyPrefix
return String>.Dictionary

Default public_oe static_oe property

Gets or sets the default Configuration.
public static Configuration,DocRaptor.Client Default
return Configuration