SearchOptions
class SearchOptions extends Options
Options for the search 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
The starting index within the search results (used for paging). The default for this field is 0.
The maximum number of search results to return. The default for this field is 100.
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.
Details
in Options at line line 41
__construct(
array $defaults = array())
Options constructor.
in Options at line line 56
boolean
offsetExists(
string $offset)
Whether a offset exists
in Options at line line 70
mixed
offsetGet(
string $offset)
Offset to retrieve
in Options at line line 83
offsetSet(
string $offset,
mixed $value)
Offset to set
in Options at line line 95
offsetUnset(
string $offset)
Offset to unset
in Options at line line 108
static
Options
merge(
array $options)
Create an Options object from a combination of configuration arrays and other option objects
in Options at line line 128
array
toArray()
Return the generated options
in StartTrait at line line 27
StartTrait
setStart(
int $start)
The starting index within the search results (used for paging). The default for this field is 0.
in MaxResultsTrait at line line 27
MaxResultsTrait
setMaxResults(
int $set)
The maximum number of search results to return. The default for this field is 100.
in SearchModeTrait at line line 30
SearchModeTrait
setSearchMode(
SearchMode $set)
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.