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

Class AppInfo

Information about how you've registered your application with the Dropbox API.

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

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

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

Returns

string
public string
# getSecret( )

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

Your Dropbox <em>app secret</em> (OAuth calls this the <em>consumer secret</em>). 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 Dropbox\AccessType
# getAccessType( )

The type of access your app is registered for. You can see how your apps areregistered on the Dropbox developer website.

The type of access your app is registered for. You can see how your apps areregistered on the Dropbox developer website.

Returns

Dropbox\AccessType
public
# __construct( string $key, string $secret, string $accessType )

Constructor.

Constructor.

Parameters

$key
string
$key See Dropbox\AppInfo::getKey()
$secret
string
$secret See Dropbox\AppInfo::getSecret()
$accessType
string
$accessType See Dropbox\AppInfo::getAccessType()
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, secret, and access_type 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, secret, and access_type fields. Run 'php authorize.php' in the examples directory for details about what this file should look like.

Parameters

$path
string
$path Path to a JSON file

Returns

Dropbox\AppInfo
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
array
$jsonArr Output from json_decode($str, TRUE)

Returns

Dropbox\AppInfo

Throws

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