C# 클래스 DocRaptor.Client.Configuration

Represents a set of configuration settings
파일 보기 프로젝트 열기: DocRaptor/docraptor-csharp 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
ApiClient ApiClient
ApiKey String>.Dictionary
ApiKeyPrefix String>.Dictionary
Default Configuration

공개 메소드들

메소드 설명
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.

메소드 상세

AddDefaultHeader() 공개 메소드

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

Configuration() 공개 메소드

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

Configuration() 공개 메소드

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)
리턴 System

GetApiKeyWithPrefix() 공개 메소드

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

ToDebugReport() 공개 정적인 메소드

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

setApiClientUsingDefault() 공개 메소드

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

프로퍼티 상세

ApiClient 공개적으로 프로퍼티

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

ApiKey 공개적으로 프로퍼티

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

ApiKeyPrefix 공개적으로 프로퍼티

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

Default 공개적으로 정적으로 프로퍼티

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