You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/developer-portal-extend-custom-functionality.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ titleSuffix: Azure API Management
4
4
description: How to customize the managed API Management developer portal with custom functionality such as custom widgets.
5
5
author: dlepow
6
6
ms.author: danlep
7
-
ms.date: 08/09/2022
7
+
ms.date: 08/25/2022
8
8
ms.service: api-management
9
9
ms.topic: how-to
10
10
---
@@ -147,7 +147,7 @@ This [npm package](https://www.npmjs.com/package/@azure/api-management-custom-wi
147
147
|---------|---------|
148
148
|[getValues](#azureapi-management-custom-widgets-toolsgetvalues) | Returns a JSON object containing values set in the widget editor combined with default values |
149
149
|[getEditorValues](#azureapi-management-custom-widgets-toolsgeteditorvalues) | Returns a JSON object containing only values set in the widget editor |
150
-
|[buildOnChange](#azureapi-management-custom-widgets-toolsbuildonchange) | Takes one parameter: a JSON object with updated values; returns a function to update the widget values |
150
+
|[buildOnChange](#azureapi-management-custom-widgets-toolsbuildonchange) | Accepts a TypeScript type and returns a function to update the widget values. The returned function takes as parameter a JSON object with updated values and doesn't return anything.<br/><br/>Used internally in widget editor |
151
151
|[askForSecrets](#azureapi-management-custom-widgets-toolsaskforsecrets) | Returns a JavaScript promise, which after resolution returns a JSON object of data needed to communicate with backend |
152
152
|[deployNodeJs](#azureapi-management-custom-widgets-toolsdeploynodejs) | Deploys widget to blob storage |
153
153
|[getWidgetData](#azureapi-management-custom-widgets-toolsgetwidgetdata) | Returns all data passed to your custom widget from the developer portal<br/><br/>Used internally in templates |
@@ -173,11 +173,15 @@ It's intended to be used in the editor of your widget but also works in runtime.
This function is intended to be used only in the widget editor. It takes one parameter: a JSON object with updated values. It returns a function to update the widget values.
176
+
> [!NOTE]
177
+
> This function is intended to be used only in the widget editor.
178
+
179
+
Accepts a TypeScript type and returns a function to update the widget values. The returned function takes as parameter a JSON object with updated values and doesn't return anything.
This function is used internally in templates. In most implementations you shouldn't need it otherwise.
213
+
> [!NOTE]
214
+
> This function is used internally in templates. In most implementations you shouldn't need it otherwise.
210
215
211
216
This function returns all data passed to your custom widget from the developer portal. It contains other data that might be useful in debugging or in more advanced scenarios. This API is expected to change with potential breaking changes. It returns a JSON object that contains the following keys:
0 commit comments