Skip to content

Commit a3e757f

Browse files
committed
Edit
1 parent a7e98cb commit a3e757f

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/frontend/pluggable-widgets/pluggable-widgets-client-apis/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,26 +56,27 @@ export interface ActionValue {
5656
}
5757
```
5858

59-
#### canExecute {#411-canexecute}
59+
#### canExecute {#canexecute}
6060

6161
The flag `canExecute` indicates if an action can be run under current conditions. This prevents executing actions that are not allowed by the app's security settings. User roles can be set in the microflows and nanoflows, allowing users to call them. For more information on user roles and security, see the [Module Security Reference Guide](/refguide/module-security/).
6262

6363
You can also employ this flag when using a **Call microflow** action triggering a microflow with a parameter. Such an action cannot be run until a parameter object is available, for example when a parent data view has finished loading. Attempting to `execute` an action that cannot be run will have no effect, and generates a debug-level warning message.
6464

6565
The exception to this behavior is when the `ActionValue` is returned by [`ListActionValue.get()`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listactionvalue). In this case, the flag will be true when not all arguments have been loaded. Calling `execute()` for an action with loading arguments will run the action as soon as all arguments become available. While waiting, `isExecuting` will be set to `true` and subsequent calls to `execute()` are ignored. If any arguments become unavailable after loading, the action will not run and a debug-level warning message will be logged.
6666

67-
#### isExecuting {#412-isexecuting}
67+
#### isExecuting {#isexecuting}
6868

6969
The flag `isExecuting` indicates whether an action is currently running. A long-running action can take seconds to complete. Your component might use this information to render an inline loading indicator which lets users track loading progress. Often it is not desirable to allow a user to trigger multiple actions in parallel. Therefore, a component (maybe based on a configuration) can decide to skip triggering an action while a previous execution is still in progress.
7070

7171
Note that `isExecuting` indicates only whether the current action is running. It does not indicate whether a target nanoflow, microflow, or object operation is running due to another action.
7272

73-
#### execute {#413-execute}
73+
#### execute {#execute}
7474

7575
The method `execute` triggers the action. It returns nothing and does not guarantee that the action will be started synchronously. But when the action does start, the component will receive a new prop with the `isExecuting` flag set.
7676

77-
When the action property [defines action variables](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#action-xml-elements), the `execute()` method expects an object map containing a property for each variable. The variables may be passed as undefined, but need to be set explicitly.
78-
Given an action property that defines two `Decimal` variables `lat` and `long`, and a `String` variable named `label`, its `execute()` method accepts the following input.
77+
When the action property [defines action variables](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#action-xml-elements), the `execute()` method expects an object map containing a property for each variable. The variables may be passed as undefined, but need to be set explicitly.
78+
79+
Given an action property that defines two `Decimal` variables `lat` and `long`, and a `String` variable named `label`, its `execute()` method accepts the following input:
7980

8081
```ts
8182
interface MapWidgetProps {

content/en/docs/apidocs-mxsdk/apidocs/frontend/pluggable-widgets/pluggable-widgets-property-types.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -490,11 +490,10 @@ When a `dataSource` attribute is specified and configured by the user, it is pas
490490
#### XML Elements {#action-xml-elements}
491491

492492
`<actionVariables>` — Defines variables a widget provides when calling [`execute()` on an ActionValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#413-execute). The variables are made available in Studio Pro when configuring [Call a Microflow](/refguide/on-click-event/#call-microflow) and [Call a Nanoflow](/refguide/on-click-event/#call-nanoflow) actions.
493-
494493
`<actionVariable>` (required one or more) — Represents a primitive value provided by the widget as an argument when calling `ActionValue.execute()`. The variable is defined by the following attributes:
495-
- `key` (required) — The identifier of the variable used in Studio Pro and the Pluggable Widgets API.
496-
- `type` (required) — The type of the value that the variable represents. Supported types and their corresponding Typescript type are listed in the table below.
497-
- `caption` (required) — A short description of the variable that is displayed in Studio Pro.
494+
* `key` (required) — The identifier of the variable used in Studio Pro and the Pluggable Widgets API.
495+
* `type` (required) — The type of the value that the variable represents. Supported types and their corresponding Typescript type are listed in the table below.
496+
* `caption` (required) — A short description of the variable that is displayed in Studio Pro.
498497

499498
| Action Variable Type | Client Type |
500499
| -------------------- | --------- |

0 commit comments

Comments
 (0)