Class SearchOptions
The search options object
Inheritance
Inherited Members
Namespace: Dropbox.Api.Files
Assembly: Dropbox.Api.dll
Syntax
public class SearchOptions
Constructors
| Improve this Doc View SourceSearchOptions(String, UInt64, SearchOrderBy, FileStatus, Boolean, IEnumerable<String>, IEnumerable<FileCategory>)
Initializes a new instance of the SearchOptions class.
Declaration
public SearchOptions(string path = null, ulong maxResults = 100UL, SearchOrderBy orderBy = null, FileStatus fileStatus = null, bool filenameOnly = false, IEnumerable<string> fileExtensions = null, IEnumerable<FileCategory> fileCategories = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. |
System.UInt64 | maxResults | The maximum number of search results to return. |
SearchOrderBy | orderBy | Specified property of the order of search results. By default, results are sorted by relevance. |
FileStatus | fileStatus | Restricts search to the given file status. |
System.Boolean | filenameOnly | Restricts search to only match on filenames. |
System.Collections.Generic.IEnumerable<System.String> | fileExtensions | Restricts search to only the extensions specified. Only supported for active file search. |
System.Collections.Generic.IEnumerable<FileCategory> | fileCategories | Restricts search to only the file categories specified. Only supported for active file search. |
Properties
| Improve this Doc View SourceFileCategories
Restricts search to only the file categories specified. Only supported for active file search.
Declaration
public IList<FileCategory> FileCategories { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<FileCategory> |
FileExtensions
Restricts search to only the extensions specified. Only supported for active file search.
Declaration
public IList<string> FileExtensions { get; protected set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<System.String> |
FilenameOnly
Restricts search to only match on filenames.
Declaration
public bool FilenameOnly { get; protected set; }
Property Value
Type | Description |
---|---|
System.Boolean |
FileStatus
Restricts search to the given file status.
Declaration
public FileStatus FileStatus { get; protected set; }
Property Value
Type | Description |
---|---|
FileStatus |
MaxResults
The maximum number of search results to return.
Declaration
public ulong MaxResults { get; protected set; }
Property Value
Type | Description |
---|---|
System.UInt64 |
OrderBy
Specified property of the order of search results. By default, results are sorted by relevance.
Declaration
public SearchOrderBy OrderBy { get; protected set; }
Property Value
Type | Description |
---|---|
SearchOrderBy |
Path
Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified.
Declaration
public string Path { get; protected set; }
Property Value
Type | Description |
---|---|
System.String |