IPWorks Cloud 2020 Python Edition

Questions / Feedback?

search Method

Searches for resources.

Syntax

def search(folder_resource: str, query: str) -> None: ...

Remarks

This method searches for resources matching Query within the specified FolderResource.

FolderResource must be a folder path, an Id-based, relative folder path, a folder resource Id, or empty string (in which case the current user's entire Dropbox is searched). The search_categories, search_file_extensions, search_kind, and search_names_only properties may be used to further control the search options the server uses.

Calling this method will fire the on_resource_list event once for each search result, and will also populate the Resource* properties.

If there are still more search results available to list when this method returns, the search_marker property will be populated. Continue to call this method until search_marker is empty to accumulate all pages of results in the Resource* properties.

The MaxSearchResults configuration setting can be used to control how many results are returned each time this method is called.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Python Edition - Version 20.0 [Build 8265]