Specifies search criteria used to match/find files in the document manager.

FileQuery Commands

.startQuery v1.3

Starts running the search in the background. If a query is already running, this has no effect. To check the status of a started query use the isQueryFinished command.

.isQueryRunning v1.3

Returns @true if the previously started query is still underway, otherwise @false.

.stopQuery v1.3

Aborts any query that has not yet finished. Has no effect if a query is not currently running.

.matchingFilePaths v1.3

Returns an array of all file paths that have been found by the query. The array will be sorted and limited if that is specified by the search settings. The order of this array may change if the query is still running.

Note: using this command while a query is running may increase the time it takes to complete the query. Using matchingFileCount instead will not impact performance.

.matchingFileCount v1.3

Returns the number of files that have been found by the query so far.