# consent.onUpdate

{% hint style="info" %}
The Commanders Act [OnSite API stub](/trustcommander/onsite-api/getting-started.md) has to be installed before using any of the OnSite API functions.
{% endhint %}

```javascript
cact('consent.onUpdate', function (result) { ... })
```

The `consent.onUpdate` method allow to subscribe a callback function for consent updates. The callback function will be called with the updated Consent Object. It is called whenever the consent is changed via a TrustCommander banner interaction or the `consent.update` method of the OnSite API. 

The `consentObject` argument will also be enriched with an additional property `updateEvent` to signal how the update happened. It can have following values:

| Value     | Description                                                                               |
| --------- | ----------------------------------------------------------------------------------------- |
| `set`     | The consent was set.                                                                      |
| `changed` | Consent was already established and then changed.                                         |
| `revoked` | Consent was revoked by the user. Used for cleanup tasks like deleting cookie identifiers. |

{% hint style="info" %}
When consent is revoked it fires two events: One changed followed by one revoked.
{% endhint %}

## Examples

### Example to react to consent changes of a specific category

In this example the Analytics category was configured with the consent category id 2 in TrustCommander.

```javascript
cact('consent.onUpdate', function (result) { 
    
    const ANALYTICS_ID = 2;
    const analyticsCategory = result.consent.categories[ANALYTICS_ID] || {};
     
    if (analyticsCategory.status === 'on') {
    
        // Consent was provided for the category. 
    
    } else {
        
        // Consent was not provided for the category. 
           
    }
    
});
```

### Example only react to consent changes of a specific category after the initial consent was given

In this example the Analytics category was configured with the consent category id 2 in TrustCommander.

```javascript
cact('consent.onUpdate', function (result) { 

    const ANALYTICS_ID = 2;
    const analyticsCategory = result.consent.categories[ANALYTICS_ID] || {};

    if (result.updateEvent === "changed" && analyticsCategory.status === 'on') {
    
        // Consent was provided for the category during an update.
    
    } 
    
});
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://community.commandersact.com/trustcommander/onsite-api/consent.onupdate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.