SearchCategories Property
Resource categories to restrict the search to.
Syntax
dropbox.getSearchCategories([callback]) dropbox.setSearchCategories( searchCategories, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getSearchCategories([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setSearchCategories([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property may be set to a comma-separated list of resource categories to restrict the search results returned by Search. Possible categories include:
Category | Associated File Extensions |
image | jpg, png, gif, ... |
document | doc, docx, txt, ... |
spreadsheet | xls, xlsx, csv, ... |
presentation | ppt, pptx, key, ... |
audio | mp3, wav, mid, ... |
video | mov, wmv, mp4, ... |
folder | (Dropbox folders) |
paper | (Dropbox Paper documents) |
others | (all other files) |
The list of valid categories (and their associated file extensions) is defined by Dropbox and may change at any time; refer to the Dropbox API documentation for more information.
Note that the server will only apply this search restriction when SearchKind is set to dskActive (0).
This property is not available at design time.
Data Type
String