overwolf.io API
Use the overwolf.io API to check whether a certain file exists, as well as to write content into files. For more I/O functionalities, please use our simple I/O plugin.
Methods Reference
Types Reference
fileExists(filePath, callback)
Version added: 0.93
Checks for the existance of a file in the given path.
| Parameter | Type | Description |
|---|---|---|
| filePath | string | Path to check for |
| callback | function | Returns with the result |
Callback argument: Success
{ "status": "success", "found": true }
Callback argument: Failure
If the file doesn’t exist, an error status will be returned:
{"status":"error","reason":"File doesn't exists"}
writeFileContents(filePath, content, encoding, triggerUacIfRequired, callback)
Version added: 0.93
Permissions required: FileSystem
Writes content into the target file.
If the file doesn’t exist, it will be created, along with any needed directories along the path. Otherwise, the file’s content will be overwritten.
| Parameter | Type | Description |
|---|---|---|
| filePath | string | Path to check for |
| content | string | Content to write |
| encoding | eEncoding enum | Encoding to use |
| triggerUacIfRequired | bool | If additional permissions are required, triggers the Windows UAC dialog |
| callback | function | Returns with the result |
Callback argument: Success
{ "status": "success" }
Callback argument: Failure
{"status":"error"}
readFileContents(filePath,encoding, callback)
Version added: 0.93
Permissions required: FileSystem
Returns a string with the targeted file’s content.
| Parameter | Type | Description |
|---|---|---|
| filePath | string | Full path of the targeted file |
| encoding | eEncoding enum | Encoding to use |
| callback | function | Returns with the result |
Callback argument: Success
Returns a string with the targeted file’s content.
{"status":"success","content":"Hello World!"}
Callback argument: Failure
If the file doesn’t exist, an error status will be returned:
{"status":"error","reason":"File doesn't exists"}
copyFile(src, dst, overrideFile, reserved, callback)
Version added: 0.93
Permissions required: FileSystem
Copy a file from the local extension directory to a destination in the local machine.
| Parameter | Type | Description |
|---|---|---|
| src | string | A relative file path from your extension's root folder, or a full overwolf-extension:// URI to the source file |
| dst | string | Destination path to copy to including file name |
| overrideFile | bool | "true" if you want an existing file to be overwritten, "false" otherwise |
| reserved | bool | For future use |
| callback | function | Returns with the result |
Callback argument: Success
Returns a string with the targeted file’s content.
{"status":"success""}
Callback argument: Failure
{"status":"error"}
eEncoding
File encoding.
| Options |
|---|
| UTF8 |
| UTF8BOM |
| Unicode |
| UnicodeBOM |
| ASCII |