Skip to main content

Overview

APIDescription
overwolf.extensions.ExtensionType-
overwolf.extensions.ExtensionUpdateState-
overwolf.extensions.checkForExtensionUpdateChecks if an update is available for the calling extension.
overwolf.extensions.getExtensionsReturn service providers manifest data.
overwolf.extensions.getInfoGets an extension's info string.
overwolf.extensions.getManifestReturns the requested extension's manifest object.
overwolf.extensions.getRunningStateGets the running state of an extension.
overwolf.extensions.getServiceConsumersReturn service providers manifest data.
overwolf.extensions.launchLaunch an extension by its unique id.
overwolf.extensions.registerInfoRequests info updates for extension. Will also be called when the extension launches/closes.
overwolf.extensions.relaunchThe app will relaunch itself.
overwolf.extensions.setInfoSets a string or object for other extensions to read.
overwolf.extensions.unregisterInfoStop requesting info for extension.
overwolf.extensions.updateExtensionThis functions allows apps to check and perform an update without having to wait for Overwolf to do so.
overwolf.extensions.AppInstallationEvent-
overwolf.extensions.AppLaunchTriggeredEvent-
overwolf.extensions.CheckForUpdateResult-
overwolf.extensions.ExtensionUpdatedEvent-
overwolf.extensions.ExtensionWindowData-
overwolf.extensions.GetExtensionsResult-
overwolf.extensions.GetInfoResult-
overwolf.extensions.GetManifestResultRepresentation of manifest.json
overwolf.extensions.GetPhasedPercentResult-
overwolf.extensions.GetRunningStateResult-
overwolf.extensions.ManifestRepresentation of manifest.json
overwolf.extensions.Metadata-
overwolf.extensions.Point-
overwolf.extensions.ServiceProvidersDataResult-
overwolf.extensions.Size-
overwolf.extensions.UncaughtExceptionEventvoid
overwolf.extensions.UpdateExtensionResult-
overwolf.extensions.WebAppSettings-
overwolf.extensions.Permission-
overwolf.extensions.UncaughtExceptionCallbackThe following types are related to the onUncaughtException event - which is a different than the usual events.
overwolf.extensions.onAppLaunchTriggeredFires when the current app is launched while already running. This is useful in the case where the app has custom logic for clicking its dock button while it is already running. The event contaisn an 'origin' string which what triggered the app launch (dock, storeapi, odk, etc...)
overwolf.extensions.onExtensionUpdatedFires when the current app's newest version has been installed. This most often means that an app relaunch is required in order for the update to apply.
overwolf.extensions.onTrayIconDoubleClickedFired when the tray icon is double clicked.