Call (Imagine function): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Imagine:Call subtitle}} | {{Template:Imagine:Call subtitle}} | ||
This | This method calls code running in the <var class="product">Imagine Transparency</var> broker for the current transaction. | ||
</p> | |||
==Syntax== | ==Syntax== | ||
{{Template:Imagine:Call syntax}} | {{Template:Imagine:Call syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th><td> | <tr><th>%string</th><td>The value returned by the called <var class="product">Imagine</var> function. This could be anything though JSON would be the most convenient format for passing data from <var class="product">Imagine</var> to <var class="product">Model 204</var>.</td></tr> | ||
<tr><th nowrap="true"><var>%(Imagine)</var></th> | <tr><th nowrap="true"><var>%(Imagine)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>Call</var> can also be invoked via a <var>Imagine</var> object variable, which may be <var>Null</var>.</td></tr> | <td>The class name in parentheses denotes a shared method. <var>Call</var> can also be invoked via a <var>Imagine</var> object variable, which may be <var>Null</var>.</td></tr> | ||
<tr><th>name</th> | <tr><th>name</th> | ||
<td>string</td></tr> | <td>A string that contains the name of the function to be called in the <var class="product">Imagine</var> broker. The semantics of this value is under the control of the <var class="product">Imagine</var> broker.</td></tr> | ||
<tr><th><var>payload</var></th> | <tr><th><var>payload</var></th> | ||
<td>string< | <td>A string that contains data passed to the <var class="product">Imagine</var> function. This could be anything though JSON would be the most convenient format for passing data to the <var class="product">Imagine</var> function. Thwe default value for this is an empty string.</td></tr> | ||
<tr><th><var>globals</var></th> | <tr><th><var>globals</var></th> | ||
<td><var>Boolean</var> value< | <td>A <var>Boolean</var> value that indicates whether global strings (<code>$setg</code>/<code>$getg</code>) should be sent to <var class="product">Imagine</var>. The default value of this argument is <var>false</var>.</td></tr> | ||
<tr><th><var>globalImages</var></th> | <tr><th><var>globalImages</var></th> | ||
<td><var>Boolean</var> value< | <td>A <var>Boolean</var> value that indicates whether global images should be sent to <var class="product">Imagine</var>. The default value of this argument is <var>false</var>.</td></tr> | ||
<tr><th><var>recordMap</var></th> | <tr><th><var>recordMap</var></th> | ||
<td><var>Boolean</var> value<br/>The default value of this argument is [[??]].</td></tr> | <td><var>Boolean</var> value<br/>The default value of this argument is [[??]].</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
==Examples== | In <var class="product">Imagine</var>, a transaction includes both retrieval requests and updating requests. | ||
<p> | |||
Because <var class="product">Imagine Transparency</var> files and transactions are automatically kept in synch with the corresponding files in <var class="product">Model 204</var> any updates in the <var class="product">Model 204</var> transaction are visible in the <var class="product">Imagine</var> transaction and vice versa==Examples== | |||
==See also== | ==See also== | ||
{{Template:Imagine:Call footer}} | {{Template:Imagine:Call footer}} | ||
Revision as of 14:54, 25 March 2025
Run Imagine code on the Transparency Broker (Imagine class)
[Introduced in Model 204 8.0 βeta]
This method calls code running in the Imagine Transparency broker for the current transaction.
Syntax
[%string =] %(Imagine):Call( name, [payload= string], [globals= boolean], - [globalImages= boolean], [recordMap= boolean]) Throws BrokerLost
Syntax terms
| %string | The value returned by the called Imagine function. This could be anything though JSON would be the most convenient format for passing data from Imagine to Model 204. |
|---|---|
| %(Imagine) | The class name in parentheses denotes a shared method. Call can also be invoked via a Imagine object variable, which may be Null. |
| name | A string that contains the name of the function to be called in the Imagine broker. The semantics of this value is under the control of the Imagine broker. |
| payload | A string that contains data passed to the Imagine function. This could be anything though JSON would be the most convenient format for passing data to the Imagine function. Thwe default value for this is an empty string. |
| globals | A Boolean value that indicates whether global strings ($setg/$getg) should be sent to Imagine. The default value of this argument is false. |
| globalImages | A Boolean value that indicates whether global images should be sent to Imagine. The default value of this argument is false. |
| recordMap | Boolean value The default value of this argument is ??. |
Usage notes
In Imagine, a transaction includes both retrieval requests and updating requests.
Because Imagine Transparency files and transactions are automatically kept in synch with the corresponding files in Model 204 any updates in the Model 204 transaction are visible in the Imagine transaction and vice versa==Examples==