Overview

Classes

  • Dropbox\AccessToken
  • Dropbox\AccessType
  • Dropbox\AppInfo
  • Dropbox\AuthInfo
  • Dropbox\Client
  • Dropbox\Config
  • Dropbox\Path
  • Dropbox\RequestToken
  • Dropbox\Token
  • Dropbox\WebAuth
  • Dropbox\WriteMode

Exceptions

  • Dropbox\AppInfoLoadException
  • Dropbox\AuthInfoLoadException
  • Dropbox\DeserializeException
  • Dropbox\Exception
  • Dropbox\Exception_BadRequest
  • Dropbox\Exception_BadResponse
  • Dropbox\Exception_BadResponseCode
  • Dropbox\Exception_InvalidAccessToken
  • Dropbox\Exception_NetworkIO
  • Dropbox\Exception_ProtocolError
  • Dropbox\Exception_RetryLater
  • Dropbox\Exception_ServerError
  • Overview
  • Class
  • Tree

Dropbox SDK for PHP

Classes summary
Dropbox\AccessToken This token is embedded in every API request so that the Dropbox server knows the request is authorized. Each access token is associated with a specific application, so the Dropbox server knows which application is making requests.
Dropbox\AccessType An enum for the two categories of Dropbox API apps: Dropbox\AccessType::FullDropbox() and Dropbox\AccessType::AppFolder().
Dropbox\AppInfo Information about how you've registered your application with the Dropbox API.
Dropbox\AuthInfo This class contains methods to load an AppInfo and AccessToken from a JSON file. This can help simplify simple scripts (such as the example programs that come with the SDK) but is probably not useful in typical Dropbox API apps.
Dropbox\Client The class used to make most Dropbox API calls. You can use this once you've gotten an Dropbox\AccessToken via Dropbox\WebAuth.
Dropbox\Config Configure how you plan to connect to the Dropbox API (your app information, your user's locale, etc).
Dropbox\Path Path validation functions.
Dropbox\RequestToken A request token is used during the three-step OAuth web flow to identify the authorization session. Once authorization is complete and you have an access token, you don't need the request token anymore.
Dropbox\Token Common parent class for Dropbox\AccessToken and Dropbox\RequestToken.
Dropbox\WebAuth Use Dropbox\WebAuth::start() and Dropbox\WebAuth::finish() to guide your user through the process of giving your app access to their Dropbox account. At the end, you will have a Dropbox\AccessToken, which you can pass to Dropbox\Client and start making API calls.
Dropbox\WriteMode Describes how a file should be saved when it is written to Dropbox.
Exceptions summary
Dropbox\AppInfoLoadException Thrown by the AppInfo::loadXXX methods if something goes wrong.
Dropbox\AuthInfoLoadException Thrown by the AuthInfo::loadXXX methods if something goes wrong.
Dropbox\DeserializeException If, when loading a serialized Dropbox\RequestToken or Dropbox\AccessToken, the input string is malformed, this exception will be thrown.
Dropbox\Exception The base class for all API call exceptions.
Dropbox\Exception_BadRequest Thrown when the server tells us that our request was invalid. This is typically due to an HTTP 400 response from the server.
Dropbox\Exception_BadResponse When this SDK can't understand the response from the server. This could be due to a bug in this SDK or a buggy response from the Dropbox server.
Dropbox\Exception_BadResponseCode Thrown when the the Dropbox server responds with an HTTP status code we didn't expect.
Dropbox\Exception_InvalidAccessToken The Dropbox server said that the access token you used is invalid or expired. You should probably ask the user to go through the OAuth authorization flow again to get a new access token.
Dropbox\Exception_NetworkIO There was a network I/O error when making the request.
Dropbox\Exception_ProtocolError There was an protocol misunderstanding between this SDK and the server. One of us didn't understand what the other one was saying.
Dropbox\Exception_RetryLater The Dropbox server said it couldn't fulfil our request right now, but that we should try again later.
Dropbox\Exception_ServerError The Dropbox server said that there was an internal error when trying to fulfil our request. This usually corresponds to an HTTP 500 response.
Dropbox SDK for PHP API documentation generated by ApiGen 2.8.0