diff options
Diffstat (limited to 'docs/jsapi/LuCI.rpc.html')
| -rw-r--r-- | docs/jsapi/LuCI.rpc.html | 185 |
1 files changed, 172 insertions, 13 deletions
diff --git a/docs/jsapi/LuCI.rpc.html b/docs/jsapi/LuCI.rpc.html index b3d5f4a6fd..9015182904 100644 --- a/docs/jsapi/LuCI.rpc.html +++ b/docs/jsapi/LuCI.rpc.html @@ -74,12 +74,16 @@ <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> + <li data-name="LuCI#fspath"><a href="LuCI.html#fspath">fspath</a></li> + <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> + <li data-name="LuCI#hasViewPermission"><a href="LuCI.html#hasViewPermission">hasViewPermission</a></li> + <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> @@ -331,6 +335,8 @@ <li data-name="LuCI.form.AbstractValue##optional"><a href="LuCI.form.AbstractValue.html#optional">optional</a></li> + <li data-name="LuCI.form.AbstractValue##readonly"><a href="LuCI.form.AbstractValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.AbstractValue##rmempty"><a href="LuCI.form.AbstractValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.AbstractValue##uciconfig"><a href="LuCI.form.AbstractValue.html#uciconfig">uciconfig</a></li> @@ -423,6 +429,8 @@ <li data-name="LuCI.form.ButtonValue#placeholder"><a href="LuCI.form.ButtonValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.ButtonValue#readonly"><a href="LuCI.form.ButtonValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.ButtonValue#rmempty"><a href="LuCI.form.ButtonValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.ButtonValue#uciconfig"><a href="LuCI.form.ButtonValue.html#uciconfig">uciconfig</a></li> @@ -511,6 +519,8 @@ <li data-name="LuCI.form.DummyValue#placeholder"><a href="LuCI.form.DummyValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.DummyValue#readonly"><a href="LuCI.form.DummyValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.DummyValue#rmempty"><a href="LuCI.form.DummyValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.DummyValue#uciconfig"><a href="LuCI.form.DummyValue.html#uciconfig">uciconfig</a></li> @@ -595,6 +605,8 @@ <li data-name="LuCI.form.DynamicList#placeholder"><a href="LuCI.form.DynamicList.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.DynamicList#readonly"><a href="LuCI.form.DynamicList.html#readonly">readonly</a></li> + <li data-name="LuCI.form.DynamicList#rmempty"><a href="LuCI.form.DynamicList.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.DynamicList#uciconfig"><a href="LuCI.form.DynamicList.html#uciconfig">uciconfig</a></li> @@ -687,6 +699,8 @@ <li data-name="LuCI.form.FileUpload#placeholder"><a href="LuCI.form.FileUpload.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.FileUpload#readonly"><a href="LuCI.form.FileUpload.html#readonly">readonly</a></li> + <li data-name="LuCI.form.FileUpload#rmempty"><a href="LuCI.form.FileUpload.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.FileUpload#uciconfig"><a href="LuCI.form.FileUpload.html#uciconfig">uciconfig</a></li> @@ -775,6 +789,8 @@ <li data-name="LuCI.form.FlagValue#placeholder"><a href="LuCI.form.FlagValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.FlagValue#readonly"><a href="LuCI.form.FlagValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.FlagValue#rmempty"><a href="LuCI.form.FlagValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.FlagValue#uciconfig"><a href="LuCI.form.FlagValue.html#uciconfig">uciconfig</a></li> @@ -929,6 +945,8 @@ <li data-name="LuCI.form.HiddenValue#placeholder"><a href="LuCI.form.HiddenValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.HiddenValue#readonly"><a href="LuCI.form.HiddenValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.HiddenValue#rmempty"><a href="LuCI.form.HiddenValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.HiddenValue#uciconfig"><a href="LuCI.form.HiddenValue.html#uciconfig">uciconfig</a></li> @@ -997,6 +1015,10 @@ </span> <ul class="members itemMembers"> + <span class="subtitle">Members</span> + + <li data-name="LuCI.form.JSONMap#readonly"><a href="LuCI.form.JSONMap.html#readonly">readonly</a></li> + </ul> <ul class="typedefs itemMembers"> @@ -1065,6 +1087,8 @@ <li data-name="LuCI.form.ListValue#placeholder"><a href="LuCI.form.ListValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.ListValue#readonly"><a href="LuCI.form.ListValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.ListValue#rmempty"><a href="LuCI.form.ListValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.ListValue#uciconfig"><a href="LuCI.form.ListValue.html#uciconfig">uciconfig</a></li> @@ -1133,6 +1157,10 @@ </span> <ul class="members itemMembers"> + <span class="subtitle">Members</span> + + <li data-name="LuCI.form.Map##readonly"><a href="LuCI.form.Map.html#readonly">readonly</a></li> + </ul> <ul class="typedefs itemMembers"> @@ -1203,6 +1231,8 @@ <li data-name="LuCI.form.MultiValue#placeholder"><a href="LuCI.form.MultiValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.MultiValue#readonly"><a href="LuCI.form.MultiValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.MultiValue#rmempty"><a href="LuCI.form.MultiValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.MultiValue#uciconfig"><a href="LuCI.form.MultiValue.html#uciconfig">uciconfig</a></li> @@ -1343,6 +1373,8 @@ <li data-name="LuCI.form.SectionValue#placeholder"><a href="LuCI.form.SectionValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.SectionValue#readonly"><a href="LuCI.form.SectionValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.SectionValue#rmempty"><a href="LuCI.form.SectionValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.SectionValue#uciconfig"><a href="LuCI.form.SectionValue.html#uciconfig">uciconfig</a></li> @@ -1513,6 +1545,8 @@ <li data-name="LuCI.form.TextValue#placeholder"><a href="LuCI.form.TextValue.html#placeholder">placeholder</a></li> + <li data-name="LuCI.form.TextValue#readonly"><a href="LuCI.form.TextValue.html#readonly">readonly</a></li> + <li data-name="LuCI.form.TextValue#rmempty"><a href="LuCI.form.TextValue.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.TextValue#uciconfig"><a href="LuCI.form.TextValue.html#uciconfig">uciconfig</a></li> @@ -1655,6 +1689,8 @@ <li data-name="LuCI.form.Value#optional"><a href="LuCI.form.Value.html#optional">optional</a></li> + <li data-name="LuCI.form.Value#readonly"><a href="LuCI.form.Value.html#readonly">readonly</a></li> + <li data-name="LuCI.form.Value#rmempty"><a href="LuCI.form.Value.html#rmempty">rmempty</a></li> <li data-name="LuCI.form.Value#uciconfig"><a href="LuCI.form.Value.html#uciconfig">uciconfig</a></li> @@ -2462,6 +2498,36 @@ </ul> </li> + <li class="item" data-name="LuCI.session"> + <span class="title"> + <a href="LuCI.session.html">LuCI.session</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.session#getID"><a href="LuCI.session.html#getID">getID</a></li> + + <li data-name="LuCI.session#getLocalData"><a href="LuCI.session.html#getLocalData">getLocalData</a></li> + + <li data-name="LuCI.session#setLocalData"><a href="LuCI.session.html#setLocalData">setLocalData</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + <li class="item" data-name="LuCI.uci"> <span class="title"> <a href="LuCI.uci.html">LuCI.uci</a> @@ -2974,6 +3040,38 @@ </ul> </li> + <li class="item" data-name="LuCI.ui.menu"> + <span class="title"> + <a href="LuCI.ui.menu.html">LuCI.ui.menu</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.ui.menu.MenuNode"><a href="LuCI.ui.menu.html#.MenuNode">MenuNode</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.ui.menu#getChildren"><a href="LuCI.ui.menu.html#getChildren">getChildren</a></li> + + <li data-name="LuCI.ui.menu#load"><a href="LuCI.ui.menu.html#load">load</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + <li class="item" data-name="LuCI.ui.Select"> <span class="title"> <a href="LuCI.ui.Select.html">LuCI.ui.Select</a> @@ -3328,7 +3426,7 @@ and means for listing and invoking remove RPC methods.</p></div> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line456">line 456</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line465">line 465</a> </div> </div> @@ -3473,7 +3571,7 @@ and means for listing and invoking remove RPC methods.</p></div> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line294">line 294</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line302">line 302</a> </div> </div> @@ -3621,7 +3719,7 @@ signatures of each given object.</p></td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line369">line 369</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line378">line 378</a> </div> </div> @@ -3721,7 +3819,7 @@ signatures of each given object.</p></td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line348">line 348</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line357">line 357</a> </div> </div> @@ -3822,7 +3920,7 @@ requests.</td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line393">line 393</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line402">line 402</a> </div> </div> @@ -3968,7 +4066,7 @@ description.</p> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line142">line 142</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line146">line 146</a> </div> </div> @@ -4135,7 +4233,7 @@ signatures of each requested <code>ubus</code> object name will be returned.</td <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line472">line 472</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line481">line 481</a> </div> </div> @@ -4281,7 +4379,7 @@ if it has not been found.</td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line379">line 379</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line388">line 388</a> </div> </div> @@ -4397,7 +4495,7 @@ if it has not been found.</td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line359">line 359</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line368">line 368</a> </div> </div> @@ -4543,6 +4641,8 @@ requests.</p></td> + <th>Default</th> + <th class="last">Description</th> </tr> @@ -4574,6 +4674,10 @@ requests.</p></td> + <td class="default"> + + </td> + <td class="description last"><p>The name of the remote <code>ubus</code> object to invoke.</p></td> </tr> @@ -4603,6 +4707,10 @@ requests.</p></td> + <td class="default"> + + </td> + <td class="description last"><p>The name of the remote <code>ubus</code> method to invoke.</p></td> </tr> @@ -4634,6 +4742,10 @@ requests.</p></td> + <td class="default"> + + </td> + <td class="description last"><p>Lists the named parameters expected by the remote <code>ubus</code> RPC method. The arguments passed to the resulting generated method call function @@ -4683,6 +4795,10 @@ invoked with <code>filterFn(reply, [ "foo" ], "bar", "b + <td class="default"> + + </td> + <td class="description last"><p>Describes the expected return data structure. The given object is supposed to contain a single key selecting the value to use from @@ -4743,12 +4859,55 @@ be returned as default instead.</li> + <td class="default"> + + </td> + <td class="description last"><p>Specfies an optional filter function which is invoked to transform the received reply data before it is returned to the caller.</p></td> </tr> + + <tr> + + <td class="name"><code>reject</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + </td> + + + + <td class="default"> + + false + + </td> + + + <td class="description last"><p>If set to <code>true</code>, non-zero ubus call status codes are treated as fatal +error and lead to the rejection of the call promise. The default +behaviour is to resolve with the call return code value instead.</p></td> + </tr> + + </tbody> </table></dl> @@ -4790,7 +4949,7 @@ received reply data before it is returned to the caller.</p></td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line233">line 233</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line241">line 241</a> </div> </div> @@ -5003,7 +5162,7 @@ of the RPC method as-is.</td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line410">line 410</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line419">line 419</a> </div> </div> @@ -5191,7 +5350,7 @@ function will fail too, forwarding the error to the caller.</td> <div class="tag-source"> - <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line256">line 256</a> + <a href="rpc.js.html">rpc.js</a>, <a href="rpc.js.html#line264">line 264</a> </div> </div> @@ -5361,7 +5520,7 @@ to the <code>expect</code> and <code>filter</code> declarations.</td> <footer> - Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Apr 07 2020 16:33:40 GMT+0200 (Central European Summer Time) + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 16 2020 13:30:42 GMT+0200 (Central European Summer Time) </footer> </div> </div> |