v0.1.0 Master

• A
• B
• C
• D
• E
• F
• G
• H
• I
• J
• K
• L
• M
• N
• O
• P
• Q
• R
• S
• T
• U
• V
• W
• X
• Y
• Z

A

AccessToken — Class in namespace Kunnu\Dropbox\Models

$AccessToken — Property in class AccessToken

Account ID

Account — Class in namespace Kunnu\Dropbox\Models

$Account — Property in class Account

Account ID

$Account — Property in class Account

User's account type

B

$AccessToken — Property in class AccessToken

Bearer

BaseModel — Class in namespace Kunnu\Dropbox\Models

C

$DropboxGuzzleHttpClient — Property in class DropboxGuzzleHttpClient

GuzzleHttp client

$Account — Property in class Account

User's two-letter country code

CopyReference — Class in namespace Kunnu\Dropbox\Models

$File — Property in class File

The file contents

$FileMetadata — Property in class FileMetadata

For files, this is the modification time set by the desktop client when the file was added to Dropbox.

SessionPersistentDataStore::clear() — Method in class SessionPersistentDataStore

Clear the key from the store

D

DropboxGuzzleHttpClient — Class in namespace Kunnu\Dropbox\Http\Clients

DropboxGuzzleHttpClient

$Account — Property in class Account

Whether the user has been disabled

$BaseModel — Property in class BaseModel

Model Data

DeletedMetadata — Class in namespace Kunnu\Dropbox\Models

$MediaMetadata — Property in class MediaMetadata

Dimension of the photo/video.

$VideoMetadata — Property in class VideoMetadata

The duration of the video in milliseconds

E

$Account — Property in class Account

Account Email

$Account — Property in class Account

Whether the user has verified their e-mail address

Account::emailIsVerified() — Method in class Account

Whether account email is verified

$CopyReference — Property in class CopyReference

The expiration date of the copy reference

F

$RequestBodyStream — Property in class RequestBodyStream

File to be sent with the Request

File — Class in namespace Kunnu\Dropbox\Models

FileMetadata — Class in namespace Kunnu\Dropbox\Models

FileSharingInfo — Class in namespace Kunnu\Dropbox\Models

FolderMetadata — Class in namespace Kunnu\Dropbox\Models

FolderSharingInfo — Class in namespace Kunnu\Dropbox\Models

G

DropboxGuzzleHttpClient::getResponseBody() — Method in class DropboxGuzzleHttpClient

Get the Response Body

RequestBodyJsonEncoded::getBody() — Method in class RequestBodyJsonEncoded

Get the Body of the Request

RequestBodyStream::getBody() — Method in class RequestBodyStream

Get the Body of the Request

AccessToken::getToken() — Method in class AccessToken

Get Access Token

AccessToken::getTokenType() — Method in class AccessToken

Get Token Type

AccessToken::getBearer() — Method in class AccessToken

Get Bearer

AccessToken::getUid() — Method in class AccessToken

Get User ID

AccessToken::getAccountId() — Method in class AccessToken

Get Account ID

AccessToken::getTeamId() — Method in class AccessToken

Get Team ID

Account::getAccountId() — Method in class Account

Get Account ID

Account::getNameDetails() — Method in class Account

Get Account User's Name Details

Account::getDisplayName() — Method in class Account

Get Display name

Account::getEmail() — Method in class Account

Get Account Email

Account::getProfilePhotoUrl() — Method in class Account

Get Profile Pic URL

Account::getCountry() — Method in class Account

Get User's two-lettered country code

Account::getLocale() — Method in class Account

Get account language

Account::getReferralLink() — Method in class Account

Get user's referral link

Account::getAccountType() — Method in class Account

Get Account Type

BaseModel::getData() — Method in class BaseModel

Get the Model data

BaseModel::getDataProperty() — Method in class BaseModel

Get Data Property

CopyReference::getExpirationDate() — Method in class CopyReference

Get the expiration date of the copy reference

CopyReference::getMetadata() — Method in class CopyReference

The metadata for the file/folder

CopyReference::getReference() — Method in class CopyReference

Get the copy reference

DeletedMetadata::getName() — Method in class DeletedMetadata

Get the 'name' property of the metadata.

DeletedMetadata::getPathLower() — Method in class DeletedMetadata

Get the 'path_lower' property of the metadata.

DeletedMetadata::getPathDisplay() — Method in class DeletedMetadata

Get the 'path_display' property of the metadata.

DeletedMetadata::getSharingInfo() — Method in class DeletedMetadata

Get the 'sharing_info' property of the file model.

File::getMetadata() — Method in class File

The metadata for the file

File::getContents() — Method in class File

Get the file contents

FileMetadata::getId() — Method in class FileMetadata

Get the 'id' property of the file model.

FileMetadata::getName() — Method in class FileMetadata

Get the 'name' property of the file model.

FileMetadata::getRev() — Method in class FileMetadata

Get the 'rev' property of the file model.

FileMetadata::getSize() — Method in class FileMetadata

Get the 'size' property of the file model.

FileMetadata::getPathLower() — Method in class FileMetadata

Get the 'path_lower' property of the file model.

FileMetadata::getMediaInfo() — Method in class FileMetadata

Get the 'media_info' property of the file model.

FileMetadata::getSharingInfo() — Method in class FileMetadata

Get the 'sharing_info' property of the file model.

FileMetadata::getPathDisplay() — Method in class FileMetadata

Get the 'path_display' property of the file model.

FileMetadata::getClientModified() — Method in class FileMetadata

Get the 'client_modified' property of the file model.

FileMetadata::getServerModified() — Method in class FileMetadata

Get the 'server_modified' property of the file model.

FileSharingInfo::getParentSharedFolderId() — Method in class FileSharingInfo

ID of shared folder that holds this file.

FileSharingInfo::getModifiedBy() — Method in class FileSharingInfo

Get the last user who modified the file.

FolderMetadata::getId() — Method in class FolderMetadata

Get the 'id' property of the folder model.

FolderMetadata::getName() — Method in class FolderMetadata

Get the 'name' property of the folder model.

FolderMetadata::getPathLower() — Method in class FolderMetadata

Get the 'path_lower' property of the folder model.

FolderMetadata::getSharingInfo() — Method in class FolderMetadata

Get the 'sharing_info' property of the folder model.

FolderMetadata::getPathDisplay() — Method in class FolderMetadata

Get the 'path_display' property of the folder model.

FolderSharingInfo::getParentSharedFolderId() — Method in class FolderSharingInfo

ID of shared folder that holds this folder.

FolderSharingInfo::getSharedFolderId() — Method in class FolderSharingInfo

ID of shared folder.

MediaInfo::getMediaMetadata() — Method in class MediaInfo

The metadata for the photo/video.

MediaMetadata::getLocation() — Method in class MediaMetadata

Get the location of the Media

MediaMetadata::getDimensions() — Method in class MediaMetadata

Get the dimensions of the Media

MediaMetadata::getTimeTaken() — Method in class MediaMetadata

Get the Time the Media was taken on

SearchResult::getMatchType() — Method in class SearchResult

Indicates what type of match was found for the result

SearchResult::getMetadata() — Method in class SearchResult

Get the Search Result Metadata

TemporaryLink::getMetadata() — Method in class TemporaryLink

The metadata for the file

TemporaryLink::getLink() — Method in class TemporaryLink

Get the temporary link

VideoMetadata::getDuration() — Method in class VideoMetadata

Get the duration of the video

McryptRandomStringGenerator::generateString() — Method in class McryptRandomStringGenerator

Get a randomly generated secure token

OpenSslRandomStringGenerator::generateString() — Method in class OpenSslRandomStringGenerator

Get a randomly generated secure token

SessionPersistentDataStore::get() — Method in class SessionPersistentDataStore

Get a value from the store

H

$FileMetadata — Property in class FileMetadata

This flag will only be present if includehasexplicitsharedmembers is true in listfolder or getmetadata. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

FileMetadata::hasExplicitSharedMembers() — Method in class FileMetadata

Get the 'hasexplicitshared_members' property of the file model.

I

$Account — Property in class Account

Indicates whether a work account is linked

Account::isDisabled() — Method in class Account

Whether acocunt has been disabled

Account::isPaired() — Method in class Account

Whether work account is paired

$FileMetadata — Property in class FileMetadata

A unique identifier of the file

FileSharingInfo::isReadOnly() — Method in class FileSharingInfo

True if the file or folder is inside a read-only shared folder.

$FolderMetadata — Property in class FolderMetadata

A unique identifier of the folder

FolderSharingInfo::isReadOnly() — Method in class FolderSharingInfo

True if the folder or folder is inside a read-only shared folder.

MediaInfo::isPending() — Method in class MediaInfo

Indicates whether the photo/video is still under processing and is the metadata available yet.

L

$Account — Property in class Account

Language of User's account

$MediaMetadata — Property in class MediaMetadata

The GPS coordinate of the photo/video.

$TemporaryLink — Property in class TemporaryLink

The temporary link

M

$CopyReference — Property in class CopyReference

File or Folder Metadata

$File — Property in class File

File Metadata

$FileMetadata — Property in class FileMetadata

Additional information if the file is a photo or video.

$FileSharingInfo — Property in class FileSharingInfo

The last user who modified the file.

MediaInfo — Class in namespace Kunnu\Dropbox\Models

$MediaInfo — Property in class MediaInfo

MediaMetadata

MediaMetadata — Class in namespace Kunnu\Dropbox\Models

$SearchResult — Property in class SearchResult

Indicates what type of match was found for the result

$SearchResult — Property in class SearchResult

File\Folder Metadata

$TemporaryLink — Property in class TemporaryLink

File Metadata

McryptRandomStringGenerator — Class in namespace Kunnu\Dropbox\Security

N

$Account — Property in class Account

User name details

$DeletedMetadata — Property in class DeletedMetadata

The last component of the path (including extension)

$FileMetadata — Property in class FileMetadata

The last component of the path (including extension).

$FolderMetadata — Property in class FolderMetadata

The last component of the path (including extension).

O

OpenSslRandomStringGenerator — Class in namespace Kunnu\Dropbox\Security

P

$RequestBodyJsonEncoded — Property in class RequestBodyJsonEncoded

Request Params

$Account — Property in class Account

Account Profile Pic URL

$DeletedMetadata — Property in class DeletedMetadata

The lowercased full path in the user's Dropbox

$DeletedMetadata — Property in class DeletedMetadata

The cased path to be used for display purposes only.

$FileMetadata — Property in class FileMetadata

The lowercased full path in the user's Dropbox.

$FileMetadata — Property in class FileMetadata

The cased path to be used for display purposes only.

$FileSharingInfo — Property in class FileSharingInfo

ID of shared folder that holds this file.

$FolderMetadata — Property in class FolderMetadata

The lowercased full path in the user's Dropbox.

$FolderMetadata — Property in class FolderMetadata

The cased path to be used for display purposes only.

$FolderSharingInfo — Property in class FolderSharingInfo

ID of shared folder that holds this folder.

$MediaInfo — Property in class MediaInfo

Indicate the photo/video is still under processing and metadata is not available yet.

SearchResults::processItems() — Method in class SearchResults

Process items and cast them to their respective Models

$SessionPersistentDataStore — Property in class SessionPersistentDataStore

Session Variable Prefix

R

RequestBodyJsonEncoded — Class in namespace Kunnu\Dropbox\Http

RequestBodyJsonEncoded

RequestBodyStream — Class in namespace Kunnu\Dropbox\Http

RequestBodyStream

$Account — Property in class Account

User's referral link

$CopyReference — Property in class CopyReference

The copy reference

$FileMetadata — Property in class FileMetadata

A unique identifier for the current revision of a file.

$FileSharingInfo — Property in class FileSharingInfo

True if the file or folder is inside a read-only shared folder.

$FolderSharingInfo — Property in class FolderSharingInfo

True if the file or folder is inside a read-only shared folder.

S

DropboxGuzzleHttpClient::send() — Method in class DropboxGuzzleHttpClient

Send request to the server and fetch the raw response

CopyReference::setMetadata() — Method in class CopyReference

Set Metadata

$DeletedMetadata — Property in class DeletedMetadata

Set if this file is contained in a shared folder

$FileMetadata — Property in class FileMetadata

The file size in bytes.

$FileMetadata — Property in class FileMetadata

Set if this file is contained in a shared folder.

$FileMetadata — Property in class FileMetadata

The last time the file was modified on Dropbox.

$FolderMetadata — Property in class FolderMetadata

Set if this folder is contained in a shared folder.

$FolderSharingInfo — Property in class FolderSharingInfo

If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.

MediaInfo::setMediaMetadata() — Method in class MediaInfo

Set Media Metadata

SearchResult — Class in namespace Kunnu\Dropbox\Models

SearchResult::setMetadata() — Method in class SearchResult

Set Metadata

SearchResults — Class in namespace Kunnu\Dropbox\Models

TemporaryLink::setMetadata() — Method in class TemporaryLink

Set Metadata

SessionPersistentDataStore — Class in namespace Kunnu\Dropbox\Store

SessionPersistentDataStore::set() — Method in class SessionPersistentDataStore

Set a value in the store

T

$AccessToken — Property in class AccessToken

Access Token

$AccessToken — Property in class AccessToken

Token Type

$AccessToken — Property in class AccessToken

Team ID

$MediaMetadata — Property in class MediaMetadata

The timestamp when the photo/video is taken.

TemporaryLink — Class in namespace Kunnu\Dropbox\Models

U

$AccessToken — Property in class AccessToken

User ID

V

VideoMetadata — Class in namespace Kunnu\Dropbox\Models

_

DropboxGuzzleHttpClient::__construct() — Method in class DropboxGuzzleHttpClient

Create a new DropboxGuzzleHttpClient instance

RequestBodyJsonEncoded::__construct() — Method in class RequestBodyJsonEncoded

Create a new RequestBodyJsonEncoded instance

RequestBodyStream::__construct() — Method in class RequestBodyStream

Create a new RequestBodyStream instance

AccessToken::__construct() — Method in class AccessToken

Create a new AccessToken instance

Account::__construct() — Method in class Account

Create a new Account instance

BaseModel::__construct() — Method in class BaseModel

Create a new Model instance

BaseModel::__get() — Method in class BaseModel

Handle calls to undefined properties.

BaseModel::__set() — Method in class BaseModel

Handle calls to undefined properties.

CopyReference::__construct() — Method in class CopyReference

Create a new CopyReference instance

DeletedMetadata::__construct() — Method in class DeletedMetadata

Create a new DeletedtMetadata instance

File::__construct() — Method in class File

Create a new File instance

FileMetadata::__construct() — Method in class FileMetadata

Create a new FileMetadata instance

FileSharingInfo::__construct() — Method in class FileSharingInfo

Create a new File Sharing Info instance

FolderMetadata::__construct() — Method in class FolderMetadata

Create a new FolderMetadata instance

FolderSharingInfo::__construct() — Method in class FolderSharingInfo

Create a new Folder Sharing Info instance

MediaInfo::__construct() — Method in class MediaInfo

Create a new MediaInfo instance

MediaMetadata::__construct() — Method in class MediaMetadata

Create a new MediaMetadata instance

SearchResult::__construct() — Method in class SearchResult

Create a new SearchResult instance

TemporaryLink::__construct() — Method in class TemporaryLink

Create a new TemporaryLink instance

VideoMetadata::__construct() — Method in class VideoMetadata

Create a new VideoMetadata instance

McryptRandomStringGenerator::__construct() — Method in class McryptRandomStringGenerator

Create a new McryptRandomStringGenerator instance

OpenSslRandomStringGenerator::__construct() — Method in class OpenSslRandomStringGenerator

Create a new OpenSslRandomStringGenerator instance

SessionPersistentDataStore::__construct() — Method in class SessionPersistentDataStore

Create a new SessionPersistentDataStore instance

Generated by Sami, the API Documentation Generator.