Class Configuration

Represents a set of configuration settings.

Inheritance

System.Object

Configuration

GlobalConfiguration

Implements

IReadableConfiguration

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public class Configuration : object, IReadableConfiguration

Constructors

| Improve this Doc View Source

Configuration()

Initializes a new instance of the Configuration class.

Declaration

public Configuration()

| Improve this Doc View Source

Configuration(IDictionary<String, String>, IDictionary<String, String>, IDictionary<String, String>, String)

Initializes a new instance of the Configuration class.

Declaration

public Configuration(IDictionary<string, string> defaultHeader, IDictionary<string, string> apiKey, IDictionary<string, string> apiKeyPrefix, string basePath = null)

Parameters

Type	Name	Description
IDictionary<System.String, System.String>	defaultHeader
IDictionary<System.String, System.String>	apiKey
IDictionary<System.String, System.String>	apiKeyPrefix
System.String	basePath

Fields

| Improve this Doc View Source

ApiBaseUrl

Default base URL of the API endpoint.

Declaration

public const string ApiBaseUrl = null

Field Value

Type	Description
System.String	Default base URL of the API endpoint.

| Improve this Doc View Source

DefaultExceptionFactory

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

Declaration

public static readonly ExceptionFactory DefaultExceptionFactory

Field Value

Type	Description
ExceptionFactory

| Improve this Doc View Source

ISO8601_DATETIME_FORMAT

Identifier for ISO 8601 DateTime Format.

Declaration

public const string ISO8601_DATETIME_FORMAT = null

Field Value

Type	Description
System.String

Remarks

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

| Improve this Doc View Source

Version

Version of the package.

Declaration

public const string Version = null

Field Value

Type	Description
System.String	Version of the package.

Properties

| Improve this Doc View Source

ApiClient

Gets an instance of an ApiClient for this configuration.

Declaration

public virtual ApiClient ApiClient { get; set; }

Property Value

Type	Description
ApiClient

| Improve this Doc View Source

BasePath

Gets or sets the base path for API access.

Declaration

public virtual string BasePath { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

BearerToken

Gets or sets the authentication token for OAuth2 authentication as Bearer token in the header.

Declaration

public virtual string BearerToken { set; }

Property Value

Type	Description
System.String	The access token.

| Improve this Doc View Source

DateTimeFormat

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

Declaration

public virtual string DateTimeFormat { get; set; }

Property Value

Type	Description
System.String	The DateTimeFormat string

| Improve this Doc View Source

Default

Gets or sets the default Configuration.

Declaration

public static Configuration Default { get; set; }

Property Value

Type	Description
Configuration	Configuration.

| Improve this Doc View Source

DefaultHeader

Gets or sets the default header.

Declaration

public virtual IDictionary<string, string> DefaultHeader { get; set; }

Property Value

Type	Description
IDictionary<System.String, System.String>

| Improve this Doc View Source

TempFolderPath

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

Declaration

public virtual string TempFolderPath { get; set; }

Property Value

Type	Description
System.String	Folder path.

| Improve this Doc View Source

Timeout

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

Declaration

public virtual int Timeout { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

UserAgent

Gets or sets the HTTP user agent.

Declaration

public virtual string UserAgent { get; set; }

Property Value

Type	Description
System.String	Http user agent.

Methods

| Improve this Doc View Source

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

| Improve this Doc View Source

SetBearerToken(String)

Sets the authentication token for OAuth2 authentication as Bearer token in the header.

Declaration

public void SetBearerToken(string accessToken)

Parameters

Type	Name	Description
System.String	accessToken

| Improve this Doc View Source

ToDebugReport()

Returns a string with essential information for debugging.

Declaration

public static string ToDebugReport()

Returns

Type	Description
System.String

Implements

IReadableConfiguration