Imagine methods syntax: Difference between revisions
Jump to navigation
Jump to search
Automatically generated page update |
Automatically generated page update |
||
| Line 2: | Line 2: | ||
replaced, so any manual edits will be lost. You've been warned. --> | replaced, so any manual edits will be lost. You've been warned. --> | ||
{{Template:Syntax list header|class=Imagine}} | {{Template:Syntax list header|class=Imagine}} | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="squareb">[</span><span class="term">%string</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Imagine):[[ | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top:1px solid;"><span class="squareb">[</span><span class="term">%string</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Imagine):[[ApsySuffix (Imagine function)|ApsySuffix]]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%number</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Imagine):[[BrokerVersion (Imagine function)|BrokerVersion]]</span> | |||
Throws [[BrokerLost class|BrokerLost]]</p> | Throws [[BrokerLost class|BrokerLost]]</p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%string</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Imagine):[[Call (Imagine function)|Call]]</span><span class="literal">(</span> <span class="term" title="String">name</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">payload=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">globals=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="Boolean">globalImages=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">recordMap=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="StringListList">stringLists=</span> <span class="term" title="StringListList">stringListList</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="DollarListList">dollarLists=</span> <span class="term" title="DollarListList">dollarListList</span><span class="squareb">]</span><span class="comma">,</span> - | |||
<span class="squareb">[</span><span class="literal" title="String">apsySuffix=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span> | |||
Throws [[BrokerLost class|BrokerLost]], [[BrokerCallError class|BrokerCallError]]</p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="squareb">[</span><span class="term">%string</span><span class="literal"> =</span><span class="squareb">]</span> <span class="literal">%(Imagine):[[DbsName (Imagine function)|DbsName]]</span></p> | |||
Latest revision as of 13:42, 19 June 2026
The syntax for each of the Imagine class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Imagine methods.
[%string =] %(Imagine):ApsySuffix
[%number =] %(Imagine):BrokerVersion Throws BrokerLost
[%string =] %(Imagine):Call( name, [payload= string], [globals= boolean], - [globalImages= boolean], [recordMap= boolean], - [stringLists= stringListList], - [dollarLists= dollarListList], - [apsySuffix= string]) Throws BrokerLost, BrokerCallError
[%string =] %(Imagine):DbsName