Class DropboxClientConfig

The class which contains all configurations for Dropbox client.

Inheritance

object

DropboxClientConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api

Assembly: Dropbox.Api.dll

Syntax

public sealed class DropboxClientConfig

Constructors

DropboxClientConfig()

Initializes a new instance of the DropboxClientConfig class.

Declaration

public DropboxClientConfig()

DropboxClientConfig(string)

Initializes a new instance of the DropboxClientConfig class.

Declaration

public DropboxClientConfig(string userAgent)

Parameters

Type	Name	Description
string	userAgent	The user agent to use when making requests.

DropboxClientConfig(string, int)

Initializes a new instance of the DropboxClientConfig class.

Declaration

public DropboxClientConfig(string userAgent, int maxRetriesOnError)

Parameters

Type	Name	Description
string	userAgent	The user agent to use when making requests.
int	maxRetriesOnError	The max number retries on error.

Properties

AutoContentHash

Gets or sets a value indicating whether the SDK automatically computes and sends Dropbox content hashes for upload requests when possible. Default is true.

Declaration

public bool AutoContentHash { get; set; }

Property Value

Type	Description
bool

DisposeUploadStream

Gets or sets a value indicating whether an upload stream is disposed by the SDK after the request completes. Default is true for backwards compatibility; set to false to keep the stream open.

Declaration

public bool DisposeUploadStream { get; set; }

Property Value

Type	Description
bool

HttpClient

Gets or sets the custom http client. If not set, a default http client will be created.

Declaration

public HttpClient HttpClient { get; set; }

Property Value

Type	Description
HttpClient

LongPollHttpClient

Gets or sets the custom http client for long poll request. If not set, a default http client with a longer timeout (480 seconds) will be created.

Declaration

public HttpClient LongPollHttpClient { get; set; }

Property Value

Type	Description
HttpClient

MaxRetriesOnError

Gets or sets the max number retries on error. Default value is 4.

Declaration

public int MaxRetriesOnError { get; set; }

Property Value

Type	Description
int

UserAgent

Gets or sets the user agent to use when making requests.

Declaration

public string UserAgent { get; set; }

Property Value

Type	Description
string

Remarks

This value helps Dropbox to identify requests coming from your application. We recommend that you use the format "AppName/Version"; if a value is supplied, the string "/OfficialDropboxDotNetV2SDK/version" is appended to the user agent.