Represents a set of configuration settings More...

Inheritance diagram for DocuSign.eSign.Client.Configuration:

Public Member Functions
	Configuration (string basePath="https://www.docusign.net/restapi")
	Initializes a new instance of the Configuration class More...

string	GetApiKeyWithPrefix (string apiKeyIdentifier)
	Gets the API key with prefix. More...

void	AddDefaultHeader (string key, string value)
	Add default header. More...

void	AddApiKey (string key, string value)
	Add Api Key Header. More...

void	AddApiKeyPrefix (string key, string value)
	Sets the API key prefix. More...

Static Public Member Functions
static String	ToDebugReport ()
	Returns a string with essential information for debugging. More...

Public Attributes
const string	Version = "6.5.0"
	Version of the package. More...

const string	ISO8601_DATETIME_FORMAT = "o"
	Identifier for ISO 8601 DateTime Format More...

const int	DefaultTimeoutValue = 100000

Static Public Attributes
static readonly ExceptionFactory	DefaultExceptionFactory
	Default creation of exceptions for a given method name and response object More...

Properties
static Configuration	Default `[get, set]`
	Gets or sets the default Configuration. More...

virtual string	BasePath `[get, set]`
	Gets or sets the base path for API access. More...

virtual IDictionary< string, string >	DefaultHeader `[get, set]`
	Gets or sets the default header. More...

virtual int	Timeout `[get, set]`
	Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. More...

virtual string	UserAgent `[get, set]`
	Gets or sets the HTTP user agent. More...

virtual string	AccessToken `[get, set]`
	Gets or sets the access token for OAuth2 authentication. More...

virtual string	TempFolderPath `[get, set]`
	Gets or sets the temporary folder path to store the files downloaded from the server. More...

virtual string	DateTimeFormat `[get, set]`
	Gets or sets the date time format used when serializing in the ApiClient By default, it's set to ISO 8601 - "o", for others see: https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx No validation is done to ensure that the string you're providing is valid More...

virtual IDictionary< string, string >	ApiKeyPrefix `[get, set]`
	Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. More...

virtual IDictionary< string, string >	ApiKey `[get, set]`
	Gets or sets the API key based on the authentication name. More...

Detailed Description

Represents a set of configuration settings

Constructor & Destructor Documentation

◆ Configuration()

DocuSign.eSign.Client.Configuration.Configuration ( string basePath = "https://www.docusign.net/restapi" )

inline

Initializes a new instance of the Configuration class

Member Function Documentation

◆ AddApiKey()

void DocuSign.eSign.Client.Configuration.AddApiKey	(	string	key,
		string	value
	)

inline

Add Api Key Header.

Parameters

key	Api Key name.
value	Api Key value.

Returns

◆ AddApiKeyPrefix()

void DocuSign.eSign.Client.Configuration.AddApiKeyPrefix	(	string	key,
		string	value
	)

inline

Sets the API key prefix.

Parameters

key	Api Key name.
value	Api Key value.

◆ AddDefaultHeader()

void DocuSign.eSign.Client.Configuration.AddDefaultHeader	(	string	key,
		string	value
	)

inline

Add default header.

Parameters

key	Header field name.
value	Header field value.

Returns

◆ GetApiKeyWithPrefix()

string DocuSign.eSign.Client.Configuration.GetApiKeyWithPrefix ( string apiKeyIdentifier )

inline

Gets the API key with prefix.

Parameters

apiKeyIdentifier API key identifier (authentication scheme).

Returns: API key with prefix.

◆ ToDebugReport()

static String DocuSign.eSign.Client.Configuration.ToDebugReport ( )

inlinestatic

Returns a string with essential information for debugging.

Member Data Documentation

◆ DefaultExceptionFactory

readonly ExceptionFactory DocuSign.eSign.Client.Configuration.DefaultExceptionFactory

static

Initial value:

= (methodName, response) =>
        {
            int status = (int)response.StatusCode;
            if (status >= 400) return new ApiException(status, String.Format("Error calling {0}: {1}", methodName, response.Content), response.Content, response);
            if (status == 0) return new ApiException(status, String.Format("Error calling {0}: {1}", methodName, response.ErrorMessage), response.ErrorMessage, response);
            return null;
        }

Default creation of exceptions for a given method name and response object

◆ ISO8601_DATETIME_FORMAT

const string DocuSign.eSign.Client.Configuration.ISO8601_DATETIME_FORMAT = "o"

Identifier for ISO 8601 DateTime Format

See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information.

◆ Version

const string DocuSign.eSign.Client.Configuration.Version = "6.5.0"

Version of the package.

Property Documentation

◆ AccessToken

virtual string DocuSign.eSign.Client.Configuration.AccessToken

getset

Gets or sets the access token for OAuth2 authentication.

The access token.

◆ ApiKey

virtual IDictionary<string, string> DocuSign.eSign.Client.Configuration.ApiKey

getset

Gets or sets the API key based on the authentication name.

The API key.

◆ ApiKeyPrefix

virtual IDictionary<string, string> DocuSign.eSign.Client.Configuration.ApiKeyPrefix

getset

Gets or sets the prefix (e.g. Token) of the API key based on the authentication name.

The prefix of the API key.

◆ BasePath

virtual string DocuSign.eSign.Client.Configuration.BasePath

getset

Gets or sets the base path for API access.

◆ DateTimeFormat

virtual string DocuSign.eSign.Client.Configuration.DateTimeFormat

getset

Gets or sets the date time format used when serializing in the ApiClient By default, it's set to ISO 8601 - "o", for others see: https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx No validation is done to ensure that the string you're providing is valid

The DateTimeFormat string

◆ Default

Configuration DocuSign.eSign.Client.Configuration.Default

staticgetset

Gets or sets the default Configuration.

Configuration.

◆ DefaultHeader

virtual IDictionary<string, string> DocuSign.eSign.Client.Configuration.DefaultHeader

getset

Gets or sets the default header.

◆ TempFolderPath

virtual string DocuSign.eSign.Client.Configuration.TempFolderPath

getset

Gets or sets the temporary folder path to store the files downloaded from the server.

Folder path.

◆ Timeout

virtual int DocuSign.eSign.Client.Configuration.Timeout

getset

Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds.

◆ UserAgent

virtual string DocuSign.eSign.Client.Configuration.UserAgent

getset

Gets or sets the HTTP user agent.

Http user agent.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Client/Configuration.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Configuration()

Member Function Documentation

◆ AddApiKey()

◆ AddApiKeyPrefix()

◆ AddDefaultHeader()

◆ GetApiKeyWithPrefix()

◆ ToDebugReport()

Member Data Documentation

◆ DefaultExceptionFactory

◆ ISO8601_DATETIME_FORMAT

◆ Version

Property Documentation

◆ AccessToken

◆ ApiKey

◆ ApiKeyPrefix

◆ BasePath

◆ DateTimeFormat

◆ Default

◆ DefaultHeader

◆ TempFolderPath

◆ Timeout

◆ UserAgent