com.dropbox.core

Class DbxRequestConfig

java.lang.Object

com.dropbox.core.DbxRequestConfig

public class DbxRequestConfig
extends Object

A grouping of a few configuration parameters for how we should make requests to the Dropbox servers.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientIdentifier An identifier for the API client, typically of the form "Name/Version".
HttpRequestor	httpRequestor The HttpRequestor implementation to use when making HTTP requests to the Dropbox API servers.
String	userLocale The locale of the user of your app.

Constructor Summary

Constructors

Constructor and Description
DbxRequestConfig(String clientIdentifier, String userLocale)
DbxRequestConfig(String clientIdentifier, String userLocale, HttpRequestor httpRequestor)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientIdentifier

public final String clientIdentifier

An identifier for the API client, typically of the form "Name/Version". This is used to set the HTTP User-Agent header when making API requests. Example: "PhotoEditServer/1.3"

If you're the author a higher-level library on top of the basic SDK, and the "Photo Edit" Android app is using your library to access Dropbox, you should append your library's name and version to form the full identifier. For example, if your library is called "File Picker", you might set this field to: "PhotoEditAndroid/2.4 FilePicker/0.1-beta"

The exact format of the User-Agent header is described in section 3.8 of the HTTP specification.

Note that the underlying HttpRequestor may append other things to the User-Agent, such as the name of the library being used to actually make the HTTP request, or the version of the Java VM.

userLocale

public final String userLocale

The locale of the user of your app. This is used by the Dropbox server to localize user-visible strings returned by API calls. For example, DbxEntry.File.humanSize is a localized string.

If the value is null or some locale that Dropbox doesn't support, the localized strings will be in English.

httpRequestor

public final HttpRequestor httpRequestor

The HttpRequestor implementation to use when making HTTP requests to the Dropbox API servers. If you don't specify one, this defaults to StandardHttpRequestor.Instance.

Constructor Detail

DbxRequestConfig

public DbxRequestConfig(String clientIdentifier,
                String userLocale,
                HttpRequestor httpRequestor)

Parameters:

clientIdentifier - clientIdentifier

userLocale - userLocale

httpRequestor - httpRequestor

DbxRequestConfig

public DbxRequestConfig(String clientIdentifier,
                String userLocale)

Parameters:

clientIdentifier - clientIdentifier

userLocale - userLocale