Event callbacks (CMP)

onMessageReady

Event callback fires when a message is about to display. This callback returns the message_type:

onMessageReady: function (message_type) {
   console.log('message_type: ' + message_type)
}

onMessageChoiceSelect

Event callback fires when a call-to-action button in a message has been clicked. This callback returns message_type, choice_id and choice_type_id:

The choice type ID denotes the action made by an end user and is a value returned by the onMessageChoiceSelect callback event.

POST https://cdn.privacy-mgmt.com/wrapper/v2/messages/choice/gdpr/{CHOICE_TYPE_ID}?requestUUID={REQUEST_UUID}&hasCsp=true&env={ENVIRONMENT}

onMessageChoiceSelect: function (message_type, choice_id, choice_type_id) {
   console.log('message_type: ' + message_type);
   console.log('choice_id: ' + choice_id);
   console.log('choice_type_id: ' + choice_type_id);
}

onPrivacyManagerAction

Event callback fires when a privacy manager button has been clicked. This callback returns message_type, pmData object, and actionType:

pmData object

onPrivacyManagerAction: function (message_type, pmData) {
   console.log('message_type: ' + message_type);
   console.log('purposeConsent: ' + pmData.purposeConsent);
   console.log('vendorConsent: ' + pmData.vendorConsent);
   console.log(JSON.stringify(pmData));
}

onPrivacyManagerActionStatus

Event callback fires after an privacy manager button has been clicked and after network calls have finished. This callback returns message_type, status, and actionType.

onPrivacyManagerActionStatus: function(message_type, status, actionType) {
    console.log('message_type: ' + message_type);
    console.log('status: ' + status);
    console.log('actionType: ' + actionType);
}

onMessageChoiceError

Event callback fires when there is an error in the message delivery process. This callback returns the message_type and err:

onMessageChoiceError: function (message_type, err) {
   console.log('onMessageChoiceError' + message_type);
   console.log('onMessageChoiceError' + err)
}

onConsentReady

Event callback fires when the consent object is ready. This callback returns the message_type, consentUUID and euconsent:

info object

onConsentReady: function (message_type, consentUUID, euconsent) {
   console.log('message_type: ' + message_type);
   console.log('consentUUID: ' + consentUUID);
   console.log('euconsent: ' + euconsent);
   console.log(info);
}

onPMCancel

Event callback fires when a user clicks the privacy manager's cancel button. This callback returns the message_type:

onPMCancel: function (message_type) {
   console.log('message_type: ' + message_type)
}

onMessageReceiveData

This event will always fire and sends data about the message and campaign to the callback.

The callback data returns the following information:

data object

onMessageReceiveData: function (message_type, data) {
   console.log('message_type' + message_type);
   console.log('prtnUUID: ' + data.prtnUUID);
   console.log('messageId: ' + data.messageId);
   console.log('messageDescription: ' + data.messageDescription);
   console.log('bucket: ' + data.bucket);
   console.log('categoryId: ' + data.categoryId);
   console.log('subCategoryId: ' + data.subCategoryId);
   console.log(JSON.stringify(data));
}

onSPPMObjectReady

Event callback fires when the privacy manager is ready to be displayed on the page.

onSPPMObjectReady: function () {
   console.log('onSPPMObjectReady')
}

onSPReady

Event callback fires when the privacy manager is ready to be displayed on the page.

onSPReady: function () {
   console.log('onSPReady')
}

onError

Event callback fires when an error occurs. This callback function returns message_type, errorCode and errorObject:

onError: function (message_type, errorCode, errorObject, userReset){
   console.log('message_type: ' + message_type);
   console.log('errorCode: ' + errorCode);
   console.log(errorObject);
   console.log('userReset: ' + userReset);
}

The list of error codes passed that can be passed to the onError callback are: