Skip to content

Commit dd96ced

Browse files
zolkiszolkis
committed
Fix Web IDL and references for InteractionOptions fields
Signed-off-by: Zoltan Kis <[email protected]>
1 parent 13b1a24 commit dd96ced

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

‎index.html‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1031,9 +1031,9 @@ <h3>The <dfn>getThingDescription()</dfn> method</h3>
10311031
</p>
10321032
</section>
10331033

1034-
<section>
1034+
<section data-dfn-for="InteractionOptions">
10351035
<h3>
1036-
The <dfn data-dfn-for="InteractionOptions">InteractionOptions</dfn> dictionary
1036+
The <dfn>InteractionOptions</dfn> dictionary
10371037
</h3>
10381038
<p>
10391039
Holds the interaction options that need to be exposed for application scripts according to the <a>Thing Description</a>.
@@ -1097,8 +1097,8 @@ <h3>The <dfn>readProperty()</dfn> method</h3>
10971097
|propertyName|.
10981098
</li>
10991099
<li>
1100-
If |option|'s {{formIndex}} is defined, let |form| be the
1101-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1100+
If |option|'s |formIndex| is defined, let |form| be the
1101+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
11021102
array, otherwise let |form| be the first <a>Form</a> in
11031103
|interaction|'s |forms| whose |op| is `readproperty`.
11041104
</li>
@@ -1110,7 +1110,7 @@ <h3>The <dfn>readProperty()</dfn> method</h3>
11101110
Make a request to the underlying platform (via the
11111111
<a>Protocol Bindings</a>) to retrieve the value of the <a>Property</a>
11121112
given by |propertyName| using |form| and the optional URI templates
1113-
given in |options|' {{uriVariables}}.
1113+
given in |options|' |uriVariables|.
11141114
</li>
11151115
<li>
11161116
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1147,8 +1147,8 @@ <h3>The <dfn>readMultipleProperties()</dfn> method</h3>
11471147
If invoking this method is not allowed for the current scripting context for security reasons, reject |promise| with a {{SecurityError}} and abort these steps.
11481148
</li>
11491149
<li>
1150-
If |option|'s {{formIndex}} is defined, let |form| be the
1151-
<a>Form</a> associated with {{formIndex}} in ||td||'s |forms| array, otherwise let |form| be the first <a>Form</a> in ||td||'s |forms| array whose |op| is `readmultipleproperties`.
1150+
If |option|'s |formIndex| is defined, let |form| be the
1151+
<a>Form</a> associated with |formIndex| in ||td||'s |forms| array, otherwise let |form| be the first <a>Form</a> in ||td||'s |forms| array whose |op| is `readmultipleproperties`.
11521152
</li>
11531153
<li>
11541154
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
@@ -1157,7 +1157,7 @@ <h3>The <dfn>readMultipleProperties()</dfn> method</h3>
11571157
Let |result:object| be an object and for each string |name:string| in |propertyNames| add a property with key |name| and the value `null`.
11581158
</li>
11591159
<li>
1160-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to retrieve the <a>Property</a> values given by |propertyNames| with |form| and optional URI templates given in |options|' {{uriVariables}}.
1160+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to retrieve the <a>Property</a> values given by |propertyNames| with |form| and optional URI templates given in |options|' |uriVariables|.
11611161
</li>
11621162
<li>
11631163
If this cannot be done with a single request with the <a>Protocol Bindings</a>, reject |promise| with a {{NotSupportedError}} and abort these steps.
@@ -1205,14 +1205,14 @@ <h3>The <dfn>readAllProperties()</dfn> method</h3>
12051205
If invoking this method is not allowed for the current scripting context for security reasons, reject |promise| with a {{SecurityError}} and abort these steps.
12061206
</li>
12071207
<li>
1208-
If |option|'s {{formIndex}} is defined, let |form| be the
1209-
<a>Form</a> associated with {{formIndex}} in ||td||'s |forms| array, otherwise let |form| be the first <a>Form</a> in ||td||'s |forms| array whose |op| is `readallproperties`.
1208+
If |option|'s |formIndex| is defined, let |form| be the
1209+
<a>Form</a> associated with |formIndex| in ||td||'s |forms| array, otherwise let |form| be the first <a>Form</a> in ||td||'s |forms| array whose |op| is `readallproperties`.
12101210
</li>
12111211
<li>
12121212
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
12131213
</li>
12141214
<li>
1215-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to retrieve the value of the all the <a>Property</a> definitions from the <a>TD</a> with |form| and optional URI templates given in |options|' {{uriVariables}}.
1215+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to retrieve the value of the all the <a>Property</a> definitions from the <a>TD</a> with |form| and optional URI templates given in |options|' |uriVariables|.
12161216
</li>
12171217
<li>
12181218
If this cannot be done with a single request with the <a>Protocol Bindings</a> of the <a>Thing</a>, then reject |promise| with a {{NotSupportedError}} and abort these steps.
@@ -1266,8 +1266,8 @@ <h3>The <dfn>writeProperty()</dfn> method</h3>
12661266
|propertyName|.
12671267
</li>
12681268
<li>
1269-
If |option|'s {{formIndex}} is defined, let |form| be the
1270-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1269+
If |option|'s |formIndex| is defined, let |form| be the
1270+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
12711271
array, otherwise let |form| be the first <a>Form</a> in
12721272
|interaction|'s |forms| whose |op| is `writeproperty`.
12731273
</li>
@@ -1281,7 +1281,7 @@ <h3>The <dfn>writeProperty()</dfn> method</h3>
12811281
Make a request to the underlying platform (via the <a>Protocol Bindings</a>)
12821282
to write the <a>Property</a> given by |propertyName| using
12831283
|data:InteractionOutput| and the optional URI templates given in
1284-
|options|' {{uriVariables}}.
1284+
|options|' |uriVariables|.
12851285
</li>
12861286
<li>
12871287
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1321,8 +1321,8 @@ <h3>The <dfn>writeMultipleProperties()</dfn> method</h3>
13211321
{{SecurityError}} and abort these steps.
13221322
</li>
13231323
<li>
1324-
If |option|'s {{formIndex}} is defined, let |form| be the
1325-
<a>Form</a> associated with {{formIndex}} in ||td||'s |forms| array,
1324+
If |option|'s |formIndex| is defined, let |form| be the
1325+
<a>Form</a> associated with |formIndex| in ||td||'s |forms| array,
13261326
otherwise let |form| be the first <a>Form</a> in ||td||'s |forms|
13271327
array whose |op| is `writemultipleproperties`.
13281328
</li>
@@ -1350,7 +1350,7 @@ <h3>The <dfn>writeMultipleProperties()</dfn> method</h3>
13501350
Make a single request to the underlying platform (via the
13511351
<a>Protocol Bindings</a>) to write each <a>Property</a> provided in
13521352
|properties| with optional URI templates given in |options|'
1353-
{{uriVariables}}.
1353+
|uriVariables|.
13541354
</li>
13551355
<li>
13561356
If this cannot be done with a single request with the
@@ -1403,16 +1403,16 @@ <h3>The <dfn>observeProperty()</dfn> method</h3>
14031403
|propertyName|.
14041404
</li>
14051405
<li>
1406-
If |option|'s {{formIndex}} is defined, let |form| be the
1407-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1406+
If |option|'s |formIndex| is defined, let |form| be the
1407+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
14081408
array, otherwise let |form| be the first <a>Form</a> in
14091409
|interaction|'s |forms| array whose |op| is `observeproperty`.
14101410
</li>
14111411
<li>
14121412
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
14131413
</li>
14141414
<li>
1415-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to observe <a>Property</a> identified by |propertyName| with |form| and optional URI templates given in |options|' {{uriVariables}}.
1415+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to observe <a>Property</a> identified by |propertyName| with |form| and optional URI templates given in |options|' |uriVariables|.
14161416
</li>
14171417
<li>
14181418
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1455,16 +1455,16 @@ <h3>The <dfn>unobserveProperty()</dfn> method</h3>
14551455
|propertyName|.
14561456
</li>
14571457
<li>
1458-
If |option|'s {{formIndex}} is defined, let |form| be the
1459-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1458+
If |option|'s |formIndex| is defined, let |form| be the
1459+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
14601460
array, otherwise let |form| be the first <a>Form</a> in
14611461
|interaction|'s |forms| array whose |op| is `unobserveproperty`.
14621462
</li>
14631463
<li>
14641464
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
14651465
</li>
14661466
<li>
1467-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to stop observing the <a>Property</a> identified by |propertyName|, with |form| and optional URI templates given in |options|' {{uriVariables}}.
1467+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to stop observing the <a>Property</a> identified by |propertyName|, with |form| and optional URI templates given in |options|' |uriVariables|.
14681468
</li>
14691469
<li>
14701470
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1497,8 +1497,8 @@ <h3>The <dfn>invokeAction()</dfn> method</h3>
14971497
|actionName|.
14981498
</li>
14991499
<li>
1500-
If |option|'s {{formIndex}} is defined, let |form| be the
1501-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1500+
If |option|'s |formIndex| is defined, let |form| be the
1501+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
15021502
array, otherwise let |form| be the first <a>Form</a> in
15031503
|interaction|'s |forms| array whose |op| is `invokeaction`.
15041504
</li>
@@ -1509,7 +1509,7 @@ <h3>The <dfn>invokeAction()</dfn> method</h3>
15091509
Let |args| be the result of running the <a>create interaction data</a>steps on |params|, |form| and |interaction|. If that throws, reject <a>promise</a> with that exception and abort these steps.
15101510
</li>
15111511
<li>
1512-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to invoke the <a>Action</a> identified by |actionName| with parameters provided in |args| and optional URI templates given in |options|'s {{uriVariables}}.
1512+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to invoke the <a>Action</a> identified by |actionName| with parameters provided in |args| and optional URI templates given in |options|'s |uriVariables|.
15131513
</li>
15141514
<li>
15151515
If the request fails locally or returns an error over the network, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1551,17 +1551,17 @@ <h3>The <dfn>subscribeEvent()</dfn> method</h3>
15511551
Let |interaction| be the value of ||td||'s |events|'s |eventName|.
15521552
</li>
15531553
<li>
1554-
If |option|'s {{formIndex}} is defined, let |form| be the
1555-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1554+
If |option|'s |formIndex| is defined, let |form| be the
1555+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
15561556
array, otherwise let |form| be the first <a>Form</a> in
15571557
|interaction|'s |forms| array whose |op| is `subscribeevent`.
15581558
</li>
15591559
<li>
15601560
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
15611561
</li>
15621562
<li>
1563-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to subscribe to an <a>Event</a> identified by |eventName:string| with |form| and optional URI templates given in |options|' {{uriVariables}}
1564-
and optional subscription data given in |options|'s {{data}}.
1563+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to subscribe to an <a>Event</a> identified by |eventName:string| with |form| and optional URI templates given in |options|' |uriVariables|
1564+
and optional subscription data given in |options|'s |data|.
15651565
</li>
15661566
<li>
15671567
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -1596,17 +1596,17 @@ <h3>The <dfn>unsubscribeEvent()</dfn> method</h3>
15961596
Let |interaction| be the value of ||td||'s |events|'s |eventName|.
15971597
</li>
15981598
<li>
1599-
If |option|'s {{formIndex}} is defined, let |form| be the
1600-
<a>Form</a> associated with {{formIndex}} in |interaction|'s |forms|
1599+
If |option|'s |formIndex| is defined, let |form| be the
1600+
<a>Form</a> associated with |formIndex| in |interaction|'s |forms|
16011601
array, otherwise let |form| be the first <a>Form</a> in
16021602
|interaction|'s |forms| array whose |op| is `unsubscribeevent`.
16031603
</li>
16041604
<li>
16051605
If |form| is failure, reject |promise| with a {{SyntaxError}} and abort these steps.
16061606
</li>
16071607
<li>
1608-
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to unsubscribe from the <a>Event</a> identified by |eventName| with |form| and optional URI templates given in |options|' {{uriVariables}}
1609-
and optional unsubscribe data given in |options|'s {{data}}.
1608+
Make a request to the underlying platform (via the <a>Protocol Bindings</a>) to unsubscribe from the <a>Event</a> identified by |eventName| with |form| and optional URI templates given in |options|' |uriVariables|
1609+
and optional unsubscribe data given in |options|'s |data|.
16101610
</li>
16111611
<li>
16121612
If the request fails, reject |promise| with the error received from the <a>Protocol Bindings</a> and abort these steps.
@@ -2493,7 +2493,7 @@ <h3>The <dfn>EventSubscriptionHandler</dfn> callback</h3>
24932493
<ol>
24942494
<li>
24952495
Let |subscriber| be a tuple formed of |options| (from which
2496-
{{uriVariables}} and {{data}} may be used) and the
2496+
|uriVariables| and |data| may be used) and the
24972497
subscriber information needed to create an <a>Event</a>
24982498
notification response.
24992499
</li>

0 commit comments

Comments
 (0)