dropbox.files.SearchOptions

class documentation

class SearchOptions(bb.Struct): (source)

View In Hierarchy

:ivar files.SearchOptions.path: Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. :ivar files.SearchOptions.max_results: The maximum number of search results to return. :ivar files.SearchOptions.order_by: Specified property of the order of search results. By default, results are sorted by relevance. :ivar files.SearchOptions.file_status: Restricts search to the given file status. :ivar files.SearchOptions.filename_only: Restricts search to only match on filenames. :ivar files.SearchOptions.file_extensions: Restricts search to only the extensions specified. Only supported for active file search. :ivar files.SearchOptions.file_categories: Restricts search to only the file categories specified. Only supported for active file search. :ivar files.SearchOptions.account_id: Restricts results to the given account id.

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable account_id Undocumented
Instance Variable file_categories Undocumented
Instance Variable file_extensions Undocumented
Instance Variable file_status Undocumented
Instance Variable filename_only Undocumented
Instance Variable max_results Undocumented
Instance Variable order_by Undocumented
Instance Variable path Undocumented
Method _process_custom_annotations Undocumented
Class Variable _has_required_fields Undocumented
Instance Variable _account_id_value Undocumented
Instance Variable _file_categories_value Undocumented
Instance Variable _file_extensions_value Undocumented
Instance Variable _file_status_value Undocumented
Instance Variable _filename_only_value Undocumented
Instance Variable _max_results_value Undocumented
Instance Variable _order_by_value Undocumented
Instance Variable _path_value Undocumented
def __init__(self, path=None, max_results=None, order_by=None, file_status=None, filename_only=None, file_extensions=None, file_categories=None, account_id=None): (source)

Undocumented

__slots__: list[str] = (source)

Undocumented

account_id = (source)

Undocumented

file_categories = (source)

Undocumented

file_extensions = (source)

Undocumented

file_status = (source)

Undocumented

filename_only = (source)

Undocumented

max_results = (source)

Undocumented

order_by = (source)

Undocumented

path = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_has_required_fields: bool = (source)

Undocumented

_account_id_value = (source)

Undocumented

_file_categories_value = (source)

Undocumented

_file_extensions_value = (source)

Undocumented

_file_status_value = (source)

Undocumented

_filename_only_value = (source)

Undocumented

_max_results_value = (source)

Undocumented

_order_by_value = (source)

Undocumented

_path_value = (source)

Undocumented