dropboxSearch
Type
command
Summary
Searches for files and folders.
Syntax
dropboxSearch <pAccessToken>, <pPath>, <pQuery>, <pStart>, <pMaxResults>, <pMode>, [<pCallback>]
Description
Recent changes may not immediately be reflected in search results due to a short delay in indexing.
If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:
- The request ID which will be the value of the it variable after calling the command
- The HTTP response code
- The data returned which will be the same data as documented for the it variable in a synchronous request.
Parameters
| Name | Type | Description |
|---|---|---|
pAccessToken | An OAuth2 Access token to access the user's account | |
pPath | Path in the user's Dropbox to be searched. | |
pQuery | The string to search for. The search string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car"). | |
pStart | The starting index within the search results (used for paging). The default for this field is 0. | |
pMaxResults | The maximum number of search results to return. The default for this field is 100. | |
pMode | The search mode. Note that searching file content is only available for Dropbox Business accounts.
| |
pCallback | The handler to call when the request is complete. If empty the command will block until complete. |