SearchOptions

open class SearchOptions : CustomStringConvertible

The SearchOptions struct

  • Scopes the search to a path in the user’s Dropbox. Searches the entire Dropbox if not specified.

    Declaration

    Swift

    public let path: String?
  • The maximum number of search results to return.

    Declaration

    Swift

    public let maxResults: UInt64
  • Specified property of the order of search results. By default, results are sorted by relevance.

    Declaration

    Swift

    public let orderBy: Files.SearchOrderBy?
  • Restricts search to the given file status.

    Declaration

    Swift

    public let fileStatus: Files.FileStatus
  • Restricts search to only match on filenames.

    Declaration

    Swift

    public let filenameOnly: Bool
  • Restricts search to only the extensions specified. Only supported for active file search.

    Declaration

    Swift

    public let fileExtensions: Array<String>?
  • Restricts search to only the file categories specified. Only supported for active file search.

    Declaration

    Swift

    public let fileCategories: Array<Files.FileCategory>?
  • Declaration

    Swift

    open var description: String { get }