Skip to main content

OW-Electron APIs

The Overwolf APIs are used to access the features that OW-Electron provides.

Methods Reference

Events Reference

Types Reference

Methods

disableAdsFPD()

Version added: 31.4.0

Disables the use of First Party Data (email hashes).

Example

main.ts snippet

import { app as electronApp, ipcMain} from 'electron';
import { overwolf } from '@overwolf/ow-electron';

const owElectronApp = electronApp as overwolf.OverwolfApp;

...

ipcMain.handle('disable-ads-fpd', () => {
owElectronApp.overwolf.disableAdsFPD();
});

packages.hasPendingUpdates()

Version added: 31.4.0

Returns pendingUpdateResult object.

Example

main.ts snippet
import { app as electronApp, ipcMain} from 'electron';
import { overwolf } from '@overwolf/ow-electron';

const owElectronApp = electronApp as overwolf.OverwolfApp;

...

owElectronApp.overwolf.packages.on('package-update-pending', () => {
const pendingUpdateResult =
owElectronApp.overwolf.packages.hasPendingUpdates();
this.printLogMessage('*** update pending ***', pendingUpdateResult);
});

Types

pendingUpdateResult Object

ParameterTypeDescription
hasPendingUpdateboolean
detailsPackageInfo[]Package name and version. false returns empty array.

Example data: true

{"hasPendingUpdate":true,"details":[{"name":"overlay","version":"1.3.2"}]}

PackageInfo Object

ParameterTypeDescription
namestringPackage name.
versionstringPackage version.