ListFolderOptions
class ListFolderOptions extends GetMetadataOptions
Additional options for the ListFolder operation
Traits
Constants
DATETIME_FORMAT |
A Dropbox-friendly timestamp wrapper |
Methods
Create an Options object from a combination of configuration arrays and other option objects
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.
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.
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.
If true, the operation will apply to all subfolders, too. The default value is false.
Details
in Options at line line 40
__construct(
array $defaults = array())
Options constructor.
in Options at line line 55
boolean
offsetExists(
string $offset)
Whether a offset exists
in Options at line line 69
mixed
offsetGet(
string $offset)
Offset to retrieve
in Options at line line 82
offsetSet(
string $offset,
mixed $value)
Offset to set
in Options at line line 94
offsetUnset(
string $offset)
Offset to unset
in Options at line line 107
static
Options
merge(
array $options)
Create an Options object from a combination of configuration arrays and other option objects
in Options at line line 127
array
toArray()
Return the generated options
in IncludeDeletedTrait at line line 29
IncludeDeletedTrait
setIncludeDeleted(
bool $set)
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.
in IncludeHasExplicitSharedMembersTrait at line line 29
IncludeHasExplicitSharedMembersTrait
setIncludeHasExplicitSharedMembers(
bool $set)
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.
in IncludeMediaInfoTrait at line line 27
IncludeMediaInfoTrait
setIncludeMediaInfo(
bool $set)
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.
in RecursiveTrait at line line 27
RecursiveTrait
setRecursive(
bool $set)
If true, the operation will apply to all subfolders, too. The default value is false.