Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,48 @@ When a user installs an extension that requests permissions, they can manage tho
3. Find the extension in the list.
4. In the **Permissions** section under the extension details, select or clear the checkbox next to each permission to grant or revoke access.

## Reacting to Permission Changes

Extensions can subscribe to the `permissionsChanged` event on `IExtensionPermissionsApi` to be notified whenever the user grants or revokes permissions for any extension. This allows you to reactively update your extension's behavior without requiring a restart.

The event carries no arguments. When it fires, call `getPermissions()` to retrieve the current state.
Update your `main/index.ts` to the following to detect when a permission changes.

```typescript
import { IComponent, getStudioProApi } from "@mendix/extensions-api";

export const component: IComponent = {
async loaded(componentContext) {
const studioPro = getStudioProApi(componentContext);

const permissionsApi = studioPro.ui.extensionPermissions;

let currentPermissions = await permissionsApi.getPermissions();

permissionsApi.addEventListener("permissionsChanged", async () => {
const permissionsAfterChange = await permissionsApi.getPermissions();

for (const permission of permissionsAfterChange) {
if (currentPermissions.find(p => p.name === permission.name)?.granted !== permission.granted) {
if (permission.name === "runtime-configuration-private" && permission.granted === false) {
studioPro.ui.notifications.show({
title: "This extension requires a permission",
message: "We need the 'runtime-configuration-private' permission to be granted",
displayDurationInSeconds: 3
});
}
}
}

currentPermissions = permissionsAfterChange;
});
}
};
```
The `permissionsChanged` event fires for all extensions whenever any permission is granted or revoked anywhere in the system, not just for your extension. This means multiple extensions may respond to the same event simultaneously.

To check if a change affects your extension, compare the old granted state against the new one for each permission name your extension declared. Without this check, your extension fires a notification every time any permission changes, including changes unrelated to your extension.

## Available Permissions

The following permissions are available for web extensions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@ Before starting this how-to, complete the following prerequisites:

Create a menu that displays a dialog with text in the `loaded` method in the main entry point (`src/main/index.ts`). This can be done by following the steps in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).

In the example below, you create one menu item that shows a message box with the user's preferences, such as `Light` or `Dark` mode, and current language.
In the example below, you create one menu item that shows a message box with the user's preferences, such as `Light` or `Dark` mode, current language and the version of Studio Pro the user is using.

{{% alert type="info" %}}
Seeing the current Studio Pro version is available for Studio Pro 11.12 and above.
{{% /alert %}}

Replace your `src/main/index.ts` file with the following:

Expand All @@ -46,7 +50,7 @@ export const component: IComponent = {

await messageBoxApi.show(
"info",
`User Preferences are:\n Theme is: ${preferences.theme}\n Language is: ${preferences.language}`
`User Preferences are:\n Theme is: ${preferences.theme}\n Language is: ${preferences.language}\nVersion is: ${preferences.version}\n`
);
};

Expand All @@ -71,6 +75,7 @@ The `getPreferences()` function returns an object with two properties:

* Theme – either **Light** or **Dark**, representing the current theme setting in Studio Pro
* Language – a string representing the current language setting, such as `en_US` for English (United States)
* Version - a string representing the current version of Studio Pro, such as `11.12.0`.

## Extensibility Feedback

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ numberless_headings: true

These release notes cover changes to the [Extensibility API for Web Developers](/apidocs-mxsdk/apidocs/extensibility-api/).

## Version 11.12.0

* We added a `permissionsChanged` event to the [Permissions API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/extension-permissions/) that notifies you when the user changes the permissions of your extension.
* We added the `documentsChanged` event, which notifies you when a document that your extension depends on is modified in Studio Pro.
* The Studio Pro version is now available through the [Preferences API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/preference-api/).

## Version 11.11.0

* We added a **New** button to the [Element Selector API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/element-selector-api/), which allows users to add new documents and entities from the element selector.
Expand Down