Page History
...
For information about documenting handlers see Documenting handlers and handler templates below. For information about documenting API functions see the documenting api functions example.
...
For information about documenting properties see Documenting what properties do above,. For information about documenting API functions see the documenting api functions example.
...
| Note | ||
|---|---|---|
| ||
When a component (not service) 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 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 or, where possible, by using delay until form loads async api functions). |
For information about documenting API functions see the documenting api functions example.
Sync functions
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.
...
Overview
Content Tools
Activity