Sidebar
reference:scripting_reference:scripting_objects:everythinginterface
EverythingInterface
If Everything by voidtools is installed, this provides an interface that lets you easily communicate with Everything from a script. You can start and stop Everything, query its status, send it arbitrary commands and query its database.
Create an EverythingInterface object via the DOpus.Create factory method.
| Property Name | Return Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
autorun |
bool |
Returns True if Everything is configured to auto-start (via the Miscellaneous / Advanced Options Preferences page). |
||||||||||||
indexed |
int |
Returns a value indicating which attributes Everything is configured to index. This is a bitmask made up of the following values:
|
||||||||||||
isrunning |
bool |
Returns True if Everything is currently running. |
||||||||||||
roots |
object:StringSet |
Returns a set representing the drive roots that Everything has indexed. |
||||||||||||
version |
string |
Returns Everything's version number. |
| Method Name | Arguments | Return Type | Description | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Indexed |
<string:path> |
bool |
Returns True if the specified path is indexed by Everything. |
||||||||||||||||||||||||||||||||||||||||
Query |
<query> |
Sends the specified query string to Everything. Returns the results as a Vector of EverythingResult objects. All arguments after the query string are optional, and represent flags provided by the Everything API. search_flags should be a bitmask representing the EVERYTHING_IPC_xxx search flags, or a string containing one or more of the following characters. Defaults to 0 if not provided.
request_flags should be a bitmask representing the EVERYTHING_IPC_QUERY2_REQUEST_xxx request flags, or a string containing one or more of the following characters. Defaults to EVERYTHING_IPC_QUERY2_REQUEST_FULL_PATH_AND_NAME if not provided.
sort_type should be one of the EVERYTHING_IPC_SORT_xxx constants (the numeric value). Defaults to 0 if not provided. max_results lets you limit the number of results returned. Defaults to the everything_max_results advanced Preferences value if not provided. offset specifies the result offset. In conjunction with max_results this lets you query large datasets without having to deal with all the results at once. timeout specifies a timeout in milliseconds. Defaults to 1000 if not provided. |
|||||||||||||||||||||||||||||||||||||||||
RunCountGet |
<string:file> |
int |
Returns the run count for the specified file. |
||||||||||||||||||||||||||||||||||||||||
RunCountInc |
<string:file> |
int |
Increments the run count for the specified file and returns the new count. |
||||||||||||||||||||||||||||||||||||||||
RunCountSet |
<string:file> |
bool |
Sets the run count for the specified file to the value provided. Returns True on success. |
||||||||||||||||||||||||||||||||||||||||
SendCmd |
<int:command> |
int |
Sends the specified command to Everything and returns its response. The commands are documented in the Everything API SDK (e.g. 401 equates to EVERYTHING_IPC_IS_DB_LOADED and returns 1 to indicate Everything's database is loaded). |
||||||||||||||||||||||||||||||||||||||||
Start |
[<int:timeout>] |
bool |
Starts Everything if it's not already running and Opus has been configured to auto-start it. The optional timeout parameter lets you specify in milliseconds how long Opus should wait for Everything to start up before it gives up and returns failure. The default if not specified is 2500. |
||||||||||||||||||||||||||||||||||||||||
Stop |
none |
bool |
Stops Everything (tells it to quit). |