Page History
...
There are several types of sync/async api calls described below.
| Anchor | ||||
|---|---|---|---|---|
|
| Note | ||
|---|---|---|
| ||
When a component (not service) sync or simple async api function that the solution can call is implemented in browser-side component/service logic implementation ("definition" in .spec file), it is important to note that calling such a function when the form of that component is not shown already created in browser DOM will result in a temporary "force-load" of that form in a hidden div in the browser - just to be able to call that api function. As this is usually not useful and will slow-down the solution due to the hidden loading of a form, this situation should be avoided (either by the solution, calling the api call later after the form was shown, or, where possible, by using delay until form loads async api functions - see below). |
For information about documenting API functions see the documenting api functions example.
...
This is the default type of api function; the example above is a sync api function definition. Sync functions will call the client and wait for the api function to execute/return before continuing. Sync api functions can have a return value.
In case of component sync functions, if the form is not present in browser's DOM then sync calls will force-load it in a hidden div just in order to execute the sync function on the component.
Sync functions that do not block event processing
...
Just add "async": true (another optional parameter (that by default is false)) to the call definition; it means the client side api is not called right away, but at next message sent to the client.
In case of component async functions, if the form is not present in browser's DOM when the async call is supposed to execute (later) then it will force-load it in a hidden div just in order to execute the async function on the component.
| Code Block | ||
|---|---|---|
| ||
"executeSomethingLater":
{
"async": true
} |
...
Overview
Content Tools
Activity