Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DigitalFlow committed Jul 22, 2021
1 parent 617f76c commit 3bfabac
Show file tree
Hide file tree
Showing 31 changed files with 198 additions and 144 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/classes/attribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Attribute.ts#L24">src/xrm/Attribute.ts:24</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Attribute.ts#L24">src/xrm/Attribute.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -140,7 +140,7 @@ <h3>get<wbr>Required<wbr>Level</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Attribute.ts#L37">src/xrm/Attribute.ts:37</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Attribute.ts#L37">src/xrm/Attribute.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>get<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Attribute.ts#L57">src/xrm/Attribute.ts:57</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Attribute.ts#L57">src/xrm/Attribute.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>set<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Attribute.ts#L92">src/xrm/Attribute.ts:92</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Attribute.ts#L92">src/xrm/Attribute.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -258,7 +258,7 @@ <h3>set<wbr>Values</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Attribute.ts#L139">src/xrm/Attribute.ts:139</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Attribute.ts#L139">src/xrm/Attribute.ts:139</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/button.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Button.ts#L35">src/xrm/Button.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -139,7 +139,7 @@ <h3>click</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Button.ts#L79">src/xrm/Button.ts:79</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Button.ts#L79">src/xrm/Button.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -181,7 +181,7 @@ <h3>expand<wbr>More<wbr>Commands</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Button.ts#L47">src/xrm/Button.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +204,7 @@ <h3>is<wbr>Visible</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Button.ts#L102">src/xrm/Button.ts:102</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Button.ts#L102">src/xrm/Button.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/control.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Control.ts#L25">src/xrm/Control.ts:25</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Control.ts#L25">src/xrm/Control.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +138,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Control.ts#L38">src/xrm/Control.ts:38</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Control.ts#L38">src/xrm/Control.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -172,7 +172,7 @@ <h3>get<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Control.ts#L63">src/xrm/Control.ts:63</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Control.ts#L63">src/xrm/Control.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/dialog.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Dialog.ts#L8">src/xrm/Dialog.ts:8</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Dialog.ts#L8">src/xrm/Dialog.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
22 changes: 11 additions & 11 deletions docs/classes/entity.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L10">src/xrm/Entity.ts:10</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L10">src/xrm/Entity.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -146,7 +146,7 @@ <h3>activate</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L201">src/xrm/Entity.ts:201</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L201">src/xrm/Entity.ts:201</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>deactivate</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L188">src/xrm/Entity.ts:188</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L188">src/xrm/Entity.ts:188</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -202,7 +202,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L171">src/xrm/Entity.ts:171</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L171">src/xrm/Entity.ts:171</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -230,7 +230,7 @@ <h3>get<wbr>Entity<wbr>Name</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L140">src/xrm/Entity.ts:140</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L140">src/xrm/Entity.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -253,7 +253,7 @@ <h3>get<wbr>Entity<wbr>Reference</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L155">src/xrm/Entity.ts:155</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L155">src/xrm/Entity.ts:155</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -276,7 +276,7 @@ <h3>get<wbr>Id</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L125">src/xrm/Entity.ts:125</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L125">src/xrm/Entity.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -299,7 +299,7 @@ <h3>handle<wbr>Duplicate<wbr>Check</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L57">src/xrm/Entity.ts:57</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L57">src/xrm/Entity.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -325,7 +325,7 @@ <h3>no<wbr>Submit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L23">src/xrm/Entity.ts:23</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L23">src/xrm/Entity.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -353,7 +353,7 @@ <h3>refresh</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L40">src/xrm/Entity.ts:40</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L40">src/xrm/Entity.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -389,7 +389,7 @@ <h3>save</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Entity.ts#L83">src/xrm/Entity.ts:83</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Entity.ts#L83">src/xrm/Entity.ts:83</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
2 changes: 1 addition & 1 deletion docs/classes/extendederror.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/utils/RethrownError.ts#L1">src/utils/RethrownError.ts:1</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/utils/RethrownError.ts#L1">src/utils/RethrownError.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
62 changes: 58 additions & 4 deletions docs/classes/form.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ <h3>Constructors</h3>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="form.html#getavailableforms" class="tsd-kind-icon">get<wbr>Available<wbr>Forms</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="form.html#getcurrentformid" class="tsd-kind-icon">get<wbr>Current<wbr>Form<wbr>Id</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="form.html#nosubmit" class="tsd-kind-icon">no<wbr>Submit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="form.html#reset" class="tsd-kind-icon">reset</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="form.html#switch" class="tsd-kind-icon">switch</a></li>
Expand All @@ -113,7 +115,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Form.ts#L25">src/xrm/Form.ts:25</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L25">src/xrm/Form.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -129,6 +131,52 @@ <h4 class="tsd-returns-title">Returns <a href="form.html" class="tsd-signature-t
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getavailableforms" class="tsd-anchor"></a>
<h3>get<wbr>Available<wbr>Forms</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Available<wbr>Forms<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FormItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L77">src/xrm/Form.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets a list of all forms that are currently available in the form selector</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FormItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Array of objects with id and label</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getcurrentformid" class="tsd-anchor"></a>
<h3>get<wbr>Current<wbr>Form<wbr>Id</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Form<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FormItem</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L62">src/xrm/Form.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets data about the currently selected form</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FormItem</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Object containing id and label of current form</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="nosubmit" class="tsd-anchor"></a>
<h3>no<wbr>Submit</h3>
Expand All @@ -139,7 +187,7 @@ <h3>no<wbr>Submit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Form.ts#L47">src/xrm/Form.ts:47</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L47">src/xrm/Form.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -162,7 +210,7 @@ <h3>reset</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Form.ts#L38">src/xrm/Form.ts:38</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L38">src/xrm/Form.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -190,7 +238,7 @@ <h3>switch</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/cc6a281/src/xrm/Form.ts#L63">src/xrm/Form.ts:63</a></li>
<li>Defined in <a href="https://github.com/DigitalFlow/D365-UI-Test/blob/617f76c/src/xrm/Form.ts#L93">src/xrm/Form.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -297,6 +345,12 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="form.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="form.html#getavailableforms" class="tsd-kind-icon">get<wbr>Available<wbr>Forms</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="form.html#getcurrentformid" class="tsd-kind-icon">get<wbr>Current<wbr>Form<wbr>Id</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="form.html#nosubmit" class="tsd-kind-icon">no<wbr>Submit</a>
</li>
Expand Down
Loading

0 comments on commit 3bfabac

Please sign in to comment.