diff options
Diffstat (limited to 'docs/jsapi/LuCI.html')
| -rw-r--r-- | docs/jsapi/LuCI.html | 406 |
1 files changed, 384 insertions, 22 deletions
diff --git a/docs/jsapi/LuCI.html b/docs/jsapi/LuCI.html index 9c7c60f6a8..a8bf2d946e 100644 --- a/docs/jsapi/LuCI.html +++ b/docs/jsapi/LuCI.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> @@ -3385,6 +3483,9 @@ accessible using the global <code>L</code> variable.</p></div> <dt><a href="LuCI.rpc.html">rpc</a></dt> <dd></dd> + <dt><a href="LuCI.session.html">session</a></dt> + <dd></dd> + <dt><a href="LuCI.uci.html">uci</a></dt> <dd></dd> @@ -3707,7 +3808,7 @@ to request the <code>LuCI.view</code> class.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2280">line 2280</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2387">line 2387</a> </div> </div> @@ -3919,7 +4020,7 @@ as parameters.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2240">line 2240</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2346">line 2346</a> </div> </div> @@ -4151,6 +4252,161 @@ argument or copied from the given error instance.</p> <dt> <div class="nameContainer"> + <h4 class="name" id="fspath"> + + fspath<span class="signature">(<span class="optional">parts</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2752">line 2752</a> + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Construct an absolute filesystem path relative to the server +document root.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>parts</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + + <span class="optional">optional</span> + + + + + <span class="repeatable">repeatable</span> + + + <p>An array of parts to join into a path.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Return the joined path.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> <h4 class="name" id="get"> get<span class="signature">(url, <span class="optional">args</span>, cb)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<null>}</span> @@ -4158,7 +4414,7 @@ argument or copied from the given error instance.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2880">line 2880</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3051">line 3051</a> </div> </div> @@ -4370,7 +4626,7 @@ callback function. The function is a wrapper around <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3002">line 3002</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3189">line 3189</a> </div> </div> @@ -4473,7 +4729,7 @@ when it didn't run to begin with.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2514">line 2514</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2630">line 2630</a> </div> </div> @@ -4659,6 +4915,112 @@ has no sub-features.</td> <dt> <div class="nameContainer"> + <h4 class="name" id="hasViewPermission"> + + hasViewPermission<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean|null}</span> + </h4> + + + <div class="tag-source"> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3155">line 3155</a> + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Check whether a view has sufficient permissions.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + | + + null + + + </td> + <td class="description last">Returns <code>null</code> if the current session has no permission at all to +load resources required by the view. Returns <code>false</code> if readonly +permissions are granted or <code>true</code> if at least one required ACL +group is granted with write permissions.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> <h4 class="name" id="isObject"> isObject<span class="signature">(<span class="optional">val</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> @@ -4666,7 +5028,7 @@ has no sub-features.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2727">line 2727</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2898">line 2898</a> </div> </div> @@ -4821,7 +5183,7 @@ not <code>null</code>, else returns <code>false</code>.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2707">line 2707</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2878">line 2878</a> </div> </div> @@ -4921,7 +5283,7 @@ not <code>null</code>, else returns <code>false</code>.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2694">line 2694</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2865">line 2865</a> </div> </div> @@ -5078,7 +5440,7 @@ slashes and any of the other characters mentioned above.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2619">line 2619</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2790">line 2790</a> </div> </div> @@ -5265,7 +5627,7 @@ slashes and any of the other characters mentioned above.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2950">line 2950</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3121">line 3121</a> </div> </div> @@ -5570,7 +5932,7 @@ polling request.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2908">line 2908</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3079">line 3079</a> </div> </div> @@ -5785,7 +6147,7 @@ by default.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2174">line 2174</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2280">line 2280</a> </div> </div> @@ -6024,7 +6386,7 @@ argument or copied from the given error instance.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2319">line 2319</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2426">line 2426</a> </div> </div> @@ -6282,7 +6644,7 @@ class instance.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2835">line 2835</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3006">line 3006</a> </div> </div> @@ -6453,7 +6815,7 @@ to the given default value on error.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2672">line 2672</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2843">line 2843</a> </div> </div> @@ -6610,7 +6972,7 @@ slashes and any of the other characters mentioned above.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3015">line 3015</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3202">line 3202</a> </div> </div> @@ -6713,7 +7075,7 @@ when it was already running.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2756">line 2756</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2927">line 2927</a> </div> </div> @@ -6930,7 +7292,7 @@ addresses or numeric values respectively.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2989">line 2989</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3176">line 3176</a> </div> </div> @@ -7078,7 +7440,7 @@ it could not be found.</td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2801">line 2801</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2972">line 2972</a> </div> </div> @@ -7228,7 +7590,7 @@ space and returned as array.</p> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2650">line 2650</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2821">line 2821</a> </div> </div> @@ -7391,7 +7753,7 @@ slashes and any of the other characters mentioned above.</p></td> <div class="tag-source"> - <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line2839">line 2839</a> + <a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line3010">line 3010</a> </div> </div> @@ -7562,7 +7924,7 @@ else <code>null</code>.</p></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> |