Consent Management Platform

About The CMP

This page is only intended to serve as a quick reference to the CMP API. For more information about the CMP, click here.

app.overwolf.isCMPRequired()

Returns whether or not a user is required to be informed about the CMP.

import { app } from 'electron';

await app.overwolf.isCMPRequired();

app.owElectronApp.overwolf.openAdPrivacySettingsWindow();

Opens the Ad privacy settings window. Use with CMPWindowOptions object.

CMPWindowOptions object

Parameter	Type	Description
purposes	enum purposes, features, vendors	Opens the CMP type tab. Default tab is Purposes.
modal	bool	Whether this is a modal window. This only works when the window is a child. Default is true.
parent	BrowserWindow	Specify parent window. Default is null.
center	bool	Show window in the center of the screen. Default is true.
backgroundColor	string	Control the CMP preloader background window.
preLoaderSpinnerColor	string	Control the CMP preloader color (spinner).
width	number	Control the CMP Window width.
height	number	Control the CMP Window height.
x	number	Control the CMP Window left position.
y	number	Control the CMP Window top position.
language	string	The language the CMP will be displayed in.

Supported languages

Use the following table for the language parameter:

Name	Key Code
English	en
German	de
Portuguese	pt
Spanish	es
French	fr
Italian	it
Polish	pl

Example:

owElectronApp.overwolf.openAdPrivacySettingsWindow(
        {
          // Set color of the loading spinner.
          preLoaderSpinnerColor: '#ff0000',

          // Set the x position of the window.
          x: 0,

          // Set the y position of the window.
          y: 0,
        }
      );

app.overwolf.openCMPWindow()

Opens the built-in CMP window.

Deprecated

This API is deprecated. Use app.overwolf.openAdPrivacySettingsWindow() instead.

app.overwolf.openCMPWindow({
    // defaults to purposes if not defined
    tab?: ['purposes' | 'features' | 'vendors']
});