Skip to content

Commit 7509a92

Browse files
committed
Review
1 parent db3d939 commit 7509a92

2 files changed

Lines changed: 22 additions & 20 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/notification-api.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
title: "Show a Pop-up Notification Using Web API"
33
linktitle: "Show Notification"
44
url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/notification-api/
5+
description: "Describes how to display a simple pop-up notification in Studio Pro using the Web Extensibility API."
56
---
67

78
## Introduction
89

9-
This how-to describes how to show a simple pop-up notification in Studio Pro.
10+
This document describes how to display a simple pop-up notification in Studio Pro.
1011

1112
## Prerequisites
1213

13-
This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Make sure to complete that how-to before starting this one.
14+
This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Complete that how-to before starting this one.
1415

1516
## Showing a Notification
1617

17-
With the notifications API, you can show a pop-up notification when your extension loads. The notification will disappear after five seconds. To do this, follow the steps below:
18+
With the notifications API, you can show a pop-up notification when your extension loads. The notification disappears after five seconds. To do this, follow these steps:
1819

1920
1. Create an `assets` folder under your `src` folder.
2021
2. Find an icon you want to use in your notification and copy it into the `assets` folder. This example uses the file `check.png`.
@@ -32,7 +33,7 @@ With the notifications API, you can show a pop-up notification when your extensi
3233
```
3334

3435
5. Create an `images.d.ts` file inside the `assets` folder. This is a `declaration` file, as indicated by the `d` file extension.
35-
6. Add the line `declare module "*.png";` to the `images.d.ts` file. This tells TypeScript that any import ending in *.png* should be treated as a module. This enables TypeScript to handle *.png* files correctly when you import them in your code and allows you to use images in your extensions.
36+
6. Add the line `declare module "*.png";` to the `images.d.ts` file. This tells TypeScript that any import ending in *.png* should be treated as a module. This allows TypeScript to handle *.png* files correctly when you import them in your code and use images in your extensions.
3637
7. Replace your `src/main/index.ts` file with the following, using the appropriate icon name in place of `Check`:
3738

3839
```typescript
@@ -58,21 +59,21 @@ With the notifications API, you can show a pop-up notification when your extensi
5859

5960
This code does the following:
6061

61-
* It uses the `notificationsApi` from `studioPro.ui.notifications` to allow you to use the notifications API.
62-
* It implements a `loaded` method, which calls the `show` method to show a pop-up notification for five seconds with the title `Extension Loaded`, a message, and the `check.png` icon you set up earlier. For more information, see the [Full Reference for Show Method](#reference) section below.
62+
* It uses the `notificationsApi` from `studioPro.ui.notifications` to access the notifications API.
63+
* It implements a `loaded` method, which calls the `show` method to display a pop-up notification for five seconds with the title `Extension Loaded`, a message, and the `check.png` icon you set up earlier. For more information, see the [Full Reference for Show Method](#reference) section.
6364

64-
Now, when the extension loads, your notification will show in the top-right corner of Studio Pro:
65+
Now, when the extension loads, your notification shows in the upper-right corner of Studio Pro:
6566

66-
{{< figure src="/attachments/apidocs-mxsdk/apidocs/extensibility-api/web/notifications/notification.png" >}}
67+
{{< figure src="/attachments/apidocs-mxsdk/apidocs/extensibility-api/web/notifications/notification.png" alt="" >}}
6768

6869
## Full Reference for Show Method {#reference}
6970

7071
The show method has the following parameters:
7172

72-
* `title`the title of the notification
73-
* `message`the text content of the notification
74-
* `displayDurationInSeconds`an optional duration (in seconds) for the notification to remain visible; if no duration is provided, the pop-up will remain indefinitely until the user removes it themselves
75-
* `icon`an optional icon that is displayed inside the notification
73+
* `title`The title of the notification.
74+
* `message`The text content of the notification.
75+
* `displayDurationInSeconds`An optional duration (in seconds) for the notification to remain visible; if no duration is provided, the pop-up remains indefinitely until the user removes it.
76+
* `icon`An optional icon that displays inside the notification.
7677

7778
## Extensibility Feedback
7879

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/permissions.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: "Extension Permissions in Overview Pane"
33
linktitle: "Extension Permissions"
44
url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/extension-permissions/
5+
description: "Describes how the permission system works for web extensions in Studio Pro and explains how extensions request and users grant access to sensitive APIs."
56
---
67

78
## Introduction
89

9-
This how-to describes how the permission system works for web extensions in Studio Pro. Permissions allow extensions to request access to sensitive APIs or data that require explicit user consent.
10+
Permissions allow extensions to request access to sensitive APIs or data that require explicit user consent.
1011

1112
{{% alert color="info" %}}
1213
Extension permissions were introduced in version 11.9.0.
@@ -16,9 +17,9 @@ Extension permissions were introduced in version 11.9.0.
1617

1718
Web extensions can request permissions to access sensitive functionality. The permission system follows these principles:
1819

19-
* **Opt-in by default** Extensions cannot access protected APIs unless you request persmission and the extension user grants it
20-
* **User control** You decide which permissions to grant through the Extensions Overview pane in Studio Pro
21-
* **Per-project settings** Permission grants are stored per project, so a user’s approval for an extension applies only within that app. This gives them the flexibility to grant a permission in one project and choose different settings for the same extension in another.
20+
* **Opt-in by default** Extensions cannot access protected APIs unless you request permission and the extension user grants it.
21+
* **User control** You decide which permissions to grant through the Extensions Overview pane in Studio Pro.
22+
* **Per-project settings** Permission grants are stored per project, so a user’s approval for an extension applies only within that app. This gives them the flexibility to grant a permission in one project and choose different settings for the same extension in another.
2223

2324
## Requesting Permissions
2425

@@ -44,12 +45,12 @@ Setting a permission to **true** indicates that your extension requests this per
4445

4546
## Granting Permissions (User Flow)
4647

47-
When a user installs an extension that requests permissions, they can manage those permissions through the Extensions Overview pane. Follow the steps below:
48+
When a user installs an extension that requests permissions, they can manage those permissions through the Extensions Overview pane:
4849

4950
1. Open Studio Pro and load an app with the extension installed.
50-
2. Go to **View** > **Extensions Overview** to open the Extensions Overview pane.
51-
3. Find the extension in the list. Under the extension details, the **Permissions** section displays the requested permissions.
52-
4. Check or uncheck the checkbox next to each permission to grant or revoke access.
51+
2. Go to **View** > **Extensions Overview**.
52+
3. Find the extension in the list.
53+
4. In the **Permissions** section under the extension details, select or clear the checkbox next to each permission to grant or revoke access.
5354

5455
## Available Permissions
5556

0 commit comments

Comments
 (0)