A

AbstractOperationClass in namespace Alorel\Dropbox\Operation
The most abstract operation wrapper
AppendClass in namespace Alorel\Dropbox\Operation\Files\UploadSession
Append more data to an upload session. When the parameter close is set, this call will close the session. A single request should not upload more than 150 MB of file contents.
AutoRenameTraitClass in namespace Alorel\Dropbox\Options\Mixins
If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
AbstractParameterClass in namespace Alorel\Dropbox\Parameters
Topmost abstract parameter class
ThumbnailFormat::availableFormats() — Method in class ThumbnailFormat
Return the available formats
ThumbnailSize::availableSizes() — Method in class ThumbnailSize
Return a list ov available thumbnail sizes
WriteMode::add() — Method in class WriteMode
Never overwrite the existing file. The autorename strategy is to append a number to the file name. For example, "document.txt" might become "document (2).txt".

C

ContentDownloadOperationClass in namespace Alorel\Dropbox\OperationKind
Abstraction for content downloads
ContentUploadAbstractOperationClass in namespace Alorel\Dropbox\OperationKind
A wrapper for the ContentUpload group of operations
CopyClass in namespace Alorel\Dropbox\Operation\Files
The Copy operation
CreateFolderClass in namespace Alorel\Dropbox\Operation\Files
Create a folder at a given path.
CheckJobStatusClass in namespace Alorel\Dropbox\Operation\Files\SaveUrl
Check the status of a save_url job.
ClientModifiedTraitClass in namespace Alorel\Dropbox\Options\Mixins
The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified
CloseTraitClass in namespace Alorel\Dropbox\Options\Mixins
If true, current session will be closed. You cannot do upload_session/append any more to current session The default for this field is False.
CommitInfoClass in namespace Alorel\Dropbox\Parameters
Contains the path and other optional modifiers for the commit.

D

DropboxExceptionClass in namespace Alorel\Dropbox\Exception
Exception wrapper
DeleteClass in namespace Alorel\Dropbox\Operation\Files
The delete operation
DownloadClass in namespace Alorel\Dropbox\Operation\Files
Download a file
SearchMode::deletedFilename() — Method in class SearchMode
Search for deleted file and folder names.

F

FinishClass in namespace Alorel\Dropbox\Operation\Files\UploadSession
Finish an upload session and save the uploaded data to the given file path. A single request should not upload more than 150 MB of file contents.
SearchMode::filename() — Method in class SearchMode
Search file and folder names.
SearchMode::filenameAndContent() — Method in class SearchMode
Search file and folder names as well as file contents.

G

GetClass in namespace Alorel\Dropbox\Operation\Files\CopyReference
Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to copy_reference/save.
GetMetadataClass in namespace Alorel\Dropbox\Operation\Files
The get_metadata operation
GetPreviewClass in namespace Alorel\Dropbox\Operation\Files
Get a preview for a file. Currently previews are only generated for the files with the following extensions:
GetTemporaryLinkClass in namespace Alorel\Dropbox\Operation\Files
Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. Content-Type of the link is determined automatically by the file's mime type.
GetThumbnailClass in namespace Alorel\Dropbox\Operation\Files
Get the file's thumbnail
GetLatestCursorClass in namespace Alorel\Dropbox\Operation\Files\ListFolder
A way to quickly get a cursor for the folder's state. Unlike listfolder, listfolder/getlatestcursor doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.
GetAccountClass in namespace Alorel\Dropbox\Operation\Users
Get information about a user's account.
GetAccountBatchClass in namespace Alorel\Dropbox\Operation\Users
Get information about multiple user accounts. At most 300 accounts may be queried per request.
GetCurrentAccountClass in namespace Alorel\Dropbox\Operation\Users
Get information about the current user's account.
GetSpaceUsageClass in namespace Alorel\Dropbox\Operation\Users
Get the space usage information for the current user's account.
GetMetadataOptionsClass in namespace Alorel\Dropbox\Options\Builder
Additional options for the GetMetadata operation
GetThumbnailOptionsClass in namespace Alorel\Dropbox\Options\Builder
Options for the get_thumbnail operation

I

AbstractOperation::isAsync() — Method in class AbstractOperation
Return whether we're operating in async mode
IncludeDeletedTraitClass in namespace Alorel\Dropbox\Options\Mixins
If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
IncludeHasExplicitSharedMembersTraitClass in namespace Alorel\Dropbox\Options\Mixins
If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.
IncludeMediaInfoTraitClass in namespace Alorel\Dropbox\Options\Mixins
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

J

AbstractParameter::jsonSerialize() — Method in class AbstractParameter
Specify data which should be serialized to JSON
ThumbnailFormat::jpeg() — Method in class ThumbnailFormat
Set the image format to JPEG

L

ListFolderClass in namespace Alorel\Dropbox\Operation\Files\ListFolder
Returns the contents of a folder.
ListFolderContinueClass in namespace Alorel\Dropbox\Operation\Files\ListFolder
Once a cursor has been retrieved from list_folder, use this to paginate through all files and retrieve updates to the folder.
LongpollClass in namespace Alorel\Dropbox\Operation\Files\ListFolder
A longpoll endpoint to wait for changes on an account. In conjunction with list_folder/continue, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps.
ListRevisionsClass in namespace Alorel\Dropbox\Operation\Files
Return revisions of a file
ListFolderOptionsClass in namespace Alorel\Dropbox\Options\Builder
Additional options for the ListFolder operation
ListRevisionsOptionsClass in namespace Alorel\Dropbox\Options\Builder
Additional options for the list_revisions operation
LongpollOptionsClass in namespace Alorel\Dropbox\Options\Builder
Options for the Longpoll operation
LimitTraitClass in namespace Alorel\Dropbox\Options\Mixins
The maximum number of entries returned. The default for this field is 10.

M

MoveClass in namespace Alorel\Dropbox\Operation\Files
The Move operation
MaxResultsTraitClass in namespace Alorel\Dropbox\Options\Mixins
The maximum number of search results to return. The default for this field is 100.
MuteTraitClass in namespace Alorel\Dropbox\Options\Mixins
Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False.
Options::merge() — Method in class Options
Create an Options object from a combination of configuration arrays and other option objects

N

NoTokenExceptionClass in namespace Alorel\Dropbox\Exception
Exception for when the API key is not provided

O

OptionClass in namespace Alorel\Dropbox\Options
Option names
OptionsClass in namespace Alorel\Dropbox\Options
Abstract options wrapper
Options::offsetExists() — Method in class Options
Whether a offset exists
Options::offsetGet() — Method in class Options
Offset to retrieve
Options::offsetSet() — Method in class Options
Offset to set
Options::offsetUnset() — Method in class Options
Offset to unset
WriteMode::overwrite() — Method in class WriteMode
Always overwrite the existing file. The autorename strategy is the same as it is for add.

P

PermanentlyDeleteClass in namespace Alorel\Dropbox\Operation\Files
The permanently_delete operation
ThumbnailFormat::png() — Method in class ThumbnailFormat
Set the image format to PNG

R

RPCOperationClass in namespace Alorel\Dropbox\OperationKind
Wrapper for RPC endpoints
SingleArgumentRPCOperation::raw() — Method in class SingleArgumentRPCOperation
Perform the operation, returning a promise or raw response object
SourceDestRPCOperation::raw() — Method in class SourceDestRPCOperation
Perform the operation, returning a promise or raw response object
Save::raw() — Method in class Save
Perform the operation, returning a promise or raw response object
Download::raw() — Method in class Download
Perform the operation, returning a promise or raw response object
GetMetadata::raw() — Method in class GetMetadata
Perform the operation, returning a promise or raw response object
GetPreview::raw() — Method in class GetPreview
Perform the operation, returning a promise or raw response object
GetThumbnail::raw() — Method in class GetThumbnail
Perform the operation, returning a promise or raw response object
GetLatestCursor::raw() — Method in class GetLatestCursor
Perform the operation, returning a promise or raw response object
ListFolder::raw() — Method in class ListFolder
Perform the operation, returning a promise or raw response object
ListFolderContinue::raw() — Method in class ListFolderContinue
Perform the operation, returning a promise or raw response object
Longpoll::raw() — Method in class Longpoll
Perform the operation, returning a promise or raw response object
ListRevisions::raw() — Method in class ListRevisions
Perform the operation, returning a promise or raw response object
RestoreClass in namespace Alorel\Dropbox\Operation\Files
Restore a file to a specific revision
Restore::raw() — Method in class Restore
Perform the operation, returning a promise or raw response object
CheckJobStatus::raw() — Method in class CheckJobStatus
Perform the operation, returning a promise or raw response object
SaveURL::raw() — Method in class SaveURL
Perform the operation, returning a promise or raw response object
Search::raw() — Method in class Search
Perform the operation, returning a promise or raw response object
Upload::raw() — Method in class Upload
Perform the operation, returning a promise or raw response object
Append::raw() — Method in class Append
Perform the operation, returning a promise or raw response object
Finish::raw() — Method in class Finish
Perform the operation, returning a promise or raw response object
Start::raw() — Method in class Start
Perform the operation, returning a promise or raw response object
GetAccount::raw() — Method in class GetAccount
Perform the operation, returning a promise or raw response object
GetAccountBatch::raw() — Method in class GetAccountBatch
Perform the operation, returning a promise or raw response object
GetCurrentAccount::raw() — Method in class GetCurrentAccount
Perform the operation, returning a promise or raw response object
GetSpaceUsage::raw() — Method in class GetSpaceUsage
Perform the operation, returning a promise or raw response object
RecursiveTraitClass in namespace Alorel\Dropbox\Options\Mixins
If true, the operation will apply to all subfolders, too. The default value is false.
ResponseAttributeClass in namespace Alorel\Dropbox\Response
Response attributes

S

ContentDownloadOperation::send() — Method in class ContentDownloadOperation
Send our request
SingleArgumentRPCOperationClass in namespace Alorel\Dropbox\OperationKind
A subtype of RPC that only accepts a single argument
SourceDestRPCOperationClass in namespace Alorel\Dropbox\OperationKind
A subtype of RPC that only needs a source path and a destination path
AbstractOperation::setDefaultToken() — Method in class AbstractOperation
Sets the default token to use with the constructor
AbstractOperation::setAsync() — Method in class AbstractOperation
Sets the sync/async operation mode
AbstractOperation::setDefaultAsync() — Method in class AbstractOperation
Sets the default $async value for the constructor
SaveClass in namespace Alorel\Dropbox\Operation\Files\CopyReference
Save a copy reference returned by copy_reference/get to the user's Dropbox.
SaveURLClass in namespace Alorel\Dropbox\Operation\Files\SaveUrl
Save a specified URL into a file in user's Dropbox. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).
SearchClass in namespace Alorel\Dropbox\Operation\Files
Searches for files and folders. Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.
StartClass in namespace Alorel\Dropbox\Operation\Files\UploadSession
Upload sessions allow you to upload a single file using multiple requests. This call starts a new upload session with the given data. You can then use uploadsession/append to add more data and uploadsession/finish to save all the data to a file in Dropbox.
SearchOptionsClass in namespace Alorel\Dropbox\Options\Builder
Options for the search operation
AutoRenameTrait::setAutoRename() — Method in class AutoRenameTrait
If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict. The default for this field is False.
ClientModifiedTrait::setClientModified() — Method in class ClientModifiedTrait
The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
CloseTrait::setClose() — Method in class CloseTrait
If true, current session will be closed. You cannot do upload_session/append any more to current session The default for this field is False.
IncludeDeletedTrait::setIncludeDeleted() — Method in class IncludeDeletedTrait
If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned. The default for this field is False.
IncludeHasExplicitSharedMembersTrait::setIncludeHasExplicitSharedMembers() — Method in class IncludeHasExplicitSharedMembersTrait
If true, the results will include a flag for each file indicating whether or not that file has any explicit members. The default for this field is False.
IncludeMediaInfoTrait::setIncludeMediaInfo() — Method in class IncludeMediaInfoTrait
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.
LimitTrait::setLimit() — Method in class LimitTrait
The maximum number of entries returned. The default for this field is 10.
MaxResultsTrait::setMaxResults() — Method in class MaxResultsTrait
The maximum number of search results to return. The default for this field is 100.
MuteTrait::setMute() — Method in class MuteTrait
Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. The default for this field is False.
RecursiveTrait::setRecursive() — Method in class RecursiveTrait
If true, the operation will apply to all subfolders, too. The default value is false.
SearchModeTraitClass in namespace Alorel\Dropbox\Options\Mixins
The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.
SearchModeTrait::setSearchMode() — Method in class SearchModeTrait
The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. The default for this union is filename.
StartTraitClass in namespace Alorel\Dropbox\Options\Mixins
The starting index within the search results (used for paging). The default for this field is 0.
StartTrait::setStart() — Method in class StartTrait
The starting index within the search results (used for paging). The default for this field is 0.
ThumbnailFormatTrait::setThumbnailFormat() — Method in class ThumbnailFormatTrait
The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. The default for this union is jpeg.
ThumbnailSizeTrait::setThumbnailSize() — Method in class ThumbnailSizeTrait
The size for the thumbnail image. The default for this union is w64h64.
TimeoutTrait::setTimeout() — Method in class TimeoutTrait
A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30.
WriteModeTrait::setWriteMode() — Method in class WriteModeTrait
Selects what to do if the file already exists. The default for this union is add.
SearchModeClass in namespace Alorel\Dropbox\Parameters
What we're searching for

Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.
UploadSessionCursor::setOffset() — Method in class UploadSessionCursor
Sets the cursor offset

T

ThumbnailFormatTraitClass in namespace Alorel\Dropbox\Options\Mixins
The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. The default for this union is jpeg.
ThumbnailSizeTraitClass in namespace Alorel\Dropbox\Options\Mixins
The size for the thumbnail image. The default for this union is w64h64.
TimeoutTraitClass in namespace Alorel\Dropbox\Options\Mixins
A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts. The default for this field is 30.
Options::toArray() — Method in class Options
Return the generated options
ThumbnailFormatClass in namespace Alorel\Dropbox\Parameters
The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. The default for this union is jpeg.
ThumbnailSizeClass in namespace Alorel\Dropbox\Parameters
The size for the thumbnail image. The default for this union is 64x64.
Util::trimNulls() — Method in class Util
Trims nulls from the input

U

UploadClass in namespace Alorel\Dropbox\Operation\Files
Create a new file with the contents provided in the request. Do not use this to upload a file larger than 150 MB. Instead, create an upload session with upload_session/start.
UploadOptionsClass in namespace Alorel\Dropbox\Options\Builder
Additional options for the Upload operation
UploadSessionActiveOptionsClass in namespace Alorel\Dropbox\Options\Builder\UploadSession
Additional options for upload_session/start
UploadSessionCursorClass in namespace Alorel\Dropbox\Parameters
Contains the upload session ID and the offset.
WriteMode::update() — Method in class WriteMode
Overwrite if the given "rev" matches the existing file's "rev". The autorename strategy is to append the string "conflicted copy" to the file name. For example, "document.txt" might become "document (conflicted copy).txt" or "document (Panda's conflicted copy).txt".
UtilClass in namespace Alorel\Dropbox
Miscellaneous utilities

W

WriteModeTraitClass in namespace Alorel\Dropbox\Options\Mixins
Selects what to do if the file already exists. The default for this union is add.
ThumbnailSize::w32h32() — Method in class ThumbnailSize
Make the size 32 pixels wide, 32 pixels height
ThumbnailSize::w64h64() — Method in class ThumbnailSize
Make the size 64 pixels wide, 64 pixels high
ThumbnailSize::w128h128() — Method in class ThumbnailSize
Make the size 128 pixels wide, 128 pixels high
ThumbnailSize::w640h480() — Method in class ThumbnailSize
Make the size 640 pixels wide, 480 pixels high
ThumbnailSize::w1024h768() — Method in class ThumbnailSize
Make the size 1024 pixels wide, 768 pixels high
WriteModeClass in namespace Alorel\Dropbox\Parameters
Selects what to do if the file already exists. The default for this union is add.

_

NoTokenException::__construct() — Method in class NoTokenException
NoTokenException constructor.
AbstractOperation::__construct() — Method in class AbstractOperation
Operation constructor.
Options::__construct() — Method in class Options
Options constructor.
AbstractParameter::__toString() — Method in class AbstractParameter
A shorthand for JSON-encoding parameters
CommitInfo::__construct() — Method in class CommitInfo
CommitInfo constructor.
ThumbnailSize::__construct() — Method in class ThumbnailSize
ThumbnailSize constructor.
UploadSessionCursor::__construct() — Method in class UploadSessionCursor
UploadSessionCursor constructor.