Overview

Classes

  • Dropbox\AppInfo
  • Dropbox\ArrayEntryStore
  • Dropbox\AuthBase
  • Dropbox\AuthInfo
  • Dropbox\Client
  • Dropbox\OAuth1AccessToken
  • Dropbox\OAuth1Upgrader
  • Dropbox\Path
  • Dropbox\RootCertificates
  • Dropbox\Security
  • Dropbox\SSLTester
  • Dropbox\Util
  • Dropbox\WebAuth
  • Dropbox\WebAuthBase
  • Dropbox\WebAuthNoRedirect
  • Dropbox\WriteMode

Interfaces

  • Dropbox\ValueStore

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_OverQuota
  • Dropbox\Exception_ProtocolError
  • Dropbox\Exception_RetryLater
  • Dropbox\Exception_ServerError
  • Dropbox\HostLoadException
  • Dropbox\StreamReadException
  • Dropbox\WebAuthException_BadRequest
  • Dropbox\WebAuthException_BadState
  • Dropbox\WebAuthException_Csrf
  • Dropbox\WebAuthException_NotApproved
  • Dropbox\WebAuthException_Provider
  • Overview
  • Class

Class AppInfo

Your app's API key and secret.

Final
Namespace: Dropbox
Located at Dropbox/AppInfo.php
Methods summary
public string
# getKey( )

Your Dropbox app key (OAuth calls this the consumer key). You can create an app key and secret on the Dropbox developer website.

Your Dropbox app key (OAuth calls this the consumer key). You can create an app key and secret on the Dropbox developer website.

Returns

string
public string
# getSecret( )

Your Dropbox app secret (OAuth calls this the consumer secret). You can create an app key and secret on the Dropbox developer website.

Your Dropbox app secret (OAuth calls this the consumer secret). You can create an app key and secret on the Dropbox developer website.

Make sure that this is kept a secret. Someone with your app secret can impesonate your application. People sometimes ask for help on the Dropbox API forums and copy/paste code that includes their app secret. Do not do that.

Returns

string
public
# __construct( string $key, string $secret )

Constructor.

Constructor.

Parameters

$key
See Dropbox\AppInfo::getKey()
$secret
See Dropbox\AppInfo::getSecret()
public static Dropbox\AppInfo
# loadFromJsonFile( string $path )

Loads a JSON file containing information about your app. At a minimum, the file must include the "key" and "secret" fields. Run 'php authorize.php' in the examples directory for details about what this file should look like.

Loads a JSON file containing information about your app. At a minimum, the file must include the "key" and "secret" fields. Run 'php authorize.php' in the examples directory for details about what this file should look like.

Parameters

$path
Path to a JSON file

Returns

Dropbox\AppInfo

Throws

Dropbox\AppInfoLoadException
public static Dropbox\AppInfo
# loadFromJson( array $jsonArr )

Parses a JSON object to build an AppInfo object. If you would like to load this from a file, use the loadFromJsonFile() method.

Parses a JSON object to build an AppInfo object. If you would like to load this from a file, use the loadFromJsonFile() method.

Parameters

$jsonArr
Output from json_decode($str, true)

Returns

Dropbox\AppInfo

Throws

Dropbox\AppInfoLoadException
Dropbox SDK for PHP API documentation generated by ApiGen