antfarm
Version:
File automation framework for ants.
935 lines • 55.3 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>InterfaceManager | Antfarm 🐜</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/ant.css">
<script src="../assets/js/modernizr.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Antfarm 🐜</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="interfacemanager.html">InterfaceManager</a>
</li>
</ul>
<h1>Class InterfaceManager</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The interface manager allows you to separate your interface fields for stepped user interfaces.
It's a factory that handles the construction and session handling of WebhookInterface instances.</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> manager = webhook.getInterfaceManager();
manager.addField({
<span class="hljs-attr">id</span>: <span class="hljs-string">"job_number"</span>,
<span class="hljs-attr">_name</span>: <span class="hljs-string">"Job Number"</span>;
type: <span class="hljs-string">"text"</span>
});
</code></pre>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">InterfaceManager</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="interfacemanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_checkpointnest" class="tsd-kind-icon">_checkpoint<wbr>Nest</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_fields" class="tsd-kind-icon">_fields</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_handlerequest" class="tsd-kind-icon">_handle<wbr>Request</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_interfaceinstances" class="tsd-kind-icon">_interface<wbr>Instances</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_metadata" class="tsd-kind-icon">_metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_nest" class="tsd-kind-icon">_nest</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#_steps" class="tsd-kind-icon">_steps</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#e" class="tsd-kind-icon">e</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="interfacemanager.html#checkpointnest" class="tsd-kind-icon">checkpoint<wbr>Nest</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#customhandlerequest" class="tsd-kind-icon">custom<wbr>Handle<wbr>Request</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="interfacemanager.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#fields" class="tsd-kind-icon">fields</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#interfaceinstances" class="tsd-kind-icon">interface<wbr>Instances</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="interfacemanager.html#interfaceproperties" class="tsd-kind-icon">interface<wbr>Properties</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="interfacemanager.html#metadata" class="tsd-kind-icon">metadata</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#nest" class="tsd-kind-icon">nest</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="interfacemanager.html#steps" class="tsd-kind-icon">steps</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="interfacemanager.html#tooltip" class="tsd-kind-icon">tooltip</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="interfacemanager.html#addfield" class="tsd-kind-icon">add<wbr>Field</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#addinterfaceinstance" class="tsd-kind-icon">add<wbr>Interface<wbr>Instance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="interfacemanager.html#addinterfaceproperty" class="tsd-kind-icon">add<wbr>Interface<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="interfacemanager.html#addstep" class="tsd-kind-icon">add<wbr>Step</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="interfacemanager.html#checknest" class="tsd-kind-icon">check<wbr>Nest</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="interfacemanager.html#getinterface" class="tsd-kind-icon">get<wbr>Interface</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#initmetadata" class="tsd-kind-icon">init<wbr>Metadata</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="interfacemanager.html#removeinterfaceinstance" class="tsd-kind-icon">remove<wbr>Interface<wbr>Instance</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Interface<wbr>Manager<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="environment.html" class="tsd-signature-type">Environment</a>, webhookNest<span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a>, handleRequest<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfacemanager.html" class="tsd-signature-type">InterfaceManager</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L35">lib/ui/interfaceManager.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>e: <a href="environment.html" class="tsd-signature-type">Environment</a></h5>
</li>
<li>
<h5>webhookNest: <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handleRequest: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional custom request handler for webhooks.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="interfacemanager.html" class="tsd-signature-type">InterfaceManager</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_checkpointnest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _checkpoint<wbr>Nest</h3>
<div class="tsd-signature tsd-kind-icon">_checkpoint<wbr>Nest<span class="tsd-signature-symbol">:</span> <a href="foldernest.html" class="tsd-signature-type">FolderNest</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L35">lib/ui/interfaceManager.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_fields" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _fields</h3>
<div class="tsd-signature tsd-kind-icon">_fields<span class="tsd-signature-symbol">:</span> <a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L30">lib/ui/interfaceManager.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_handlerequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _handle<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">_handle<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L33">lib/ui/interfaceManager.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_interfaceinstances" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _interface<wbr>Instances</h3>
<div class="tsd-signature tsd-kind-icon">_interface<wbr>Instances<span class="tsd-signature-symbol">:</span> <a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L32">lib/ui/interfaceManager.ts:32</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_metadata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _metadata</h3>
<div class="tsd-signature tsd-kind-icon">_metadata<span class="tsd-signature-symbol">:</span> <a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L34">lib/ui/interfaceManager.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_nest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _nest</h3>
<div class="tsd-signature tsd-kind-icon">_nest<span class="tsd-signature-symbol">:</span> <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L29">lib/ui/interfaceManager.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_steps" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _steps</h3>
<div class="tsd-signature tsd-kind-icon">_steps<span class="tsd-signature-symbol">:</span> <a href="step.html" class="tsd-signature-type">Step</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L31">lib/ui/interfaceManager.ts:31</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="e" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> e</h3>
<div class="tsd-signature tsd-kind-icon">e<span class="tsd-signature-symbol">:</span> <a href="environment.html" class="tsd-signature-type">Environment</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L28">lib/ui/interfaceManager.ts:28</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="checkpointnest" class="tsd-anchor"></a>
<h3>checkpoint<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> checkpointNest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> checkpointNest<span class="tsd-signature-symbol">(</span>nest<span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L94">lib/ui/interfaceManager.ts:94</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="foldernest.html" class="tsd-signature-type">FolderNest</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L98">lib/ui/interfaceManager.ts:98</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nest: <a href="foldernest.html" class="tsd-signature-type">FolderNest</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="customhandlerequest" class="tsd-anchor"></a>
<h3>custom<wbr>Handle<wbr>Request</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> customHandleRequest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L106">lib/ui/interfaceManager.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the custom handleRequest function.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="description" class="tsd-anchor"></a>
<h3>description</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> description<span class="tsd-signature-symbol">(</span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L74">lib/ui/interfaceManager.ts:74</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>description: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="fields" class="tsd-anchor"></a>
<h3>fields</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L147">lib/ui/interfaceManager.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gets an array of interface fields.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="interfaceinstances" class="tsd-anchor"></a>
<h3>interface<wbr>Instances</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> interfaceInstances<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L90">lib/ui/interfaceManager.ts:90</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="interfaceproperties" class="tsd-anchor"></a>
<h3>interface<wbr>Properties</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> interfaceProperties<span class="tsd-signature-symbol">(</span>properties<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaceproperty.html" class="tsd-signature-type">InterfaceProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L86">lib/ui/interfaceManager.ts:86</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>properties: <a href="../interfaces/interfaceproperty.html" class="tsd-signature-type">InterfaceProperty</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="metadata" class="tsd-anchor"></a>
<h3>metadata</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> metadata<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L59">lib/ui/interfaceManager.ts:59</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L63">lib/ui/interfaceManager.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadata: <a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="nest" class="tsd-anchor"></a>
<h3>nest</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> nest<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L114">lib/ui/interfaceManager.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the nest</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="path" class="tsd-anchor"></a>
<h3>path</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> path<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L122">lib/ui/interfaceManager.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the nest _path.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="steps" class="tsd-anchor"></a>
<h3>steps</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> steps<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="step.html" class="tsd-signature-type">Step</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L183">lib/ui/interfaceManager.ts:183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an array of user interface steps.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="step.html" class="tsd-signature-type">Step</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="tooltip" class="tsd-anchor"></a>
<h3>tooltip</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> tooltip<span class="tsd-signature-symbol">(</span>tooltip<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L78">lib/ui/interfaceManager.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tooltip: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</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="addfield" class="tsd-anchor"></a>
<h3>add<wbr>Field</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Field<span class="tsd-signature-symbol">(</span>field<span class="tsd-signature-symbol">: </span><a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L130">lib/ui/interfaceManager.ts:130</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds an interface field to the interface.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>field: <a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="addinterfaceinstance" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> add<wbr>Interface<wbr>Instance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">add<wbr>Interface<wbr>Instance<span class="tsd-signature-symbol">(</span>wi<span class="tsd-signature-symbol">: </span><a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L187">lib/ui/interfaceManager.ts:187</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>wi: <a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addinterfaceproperty" class="tsd-anchor"></a>
<h3>add<wbr>Interface<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Interface<wbr>Property<span class="tsd-signature-symbol">(</span>property<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfaceproperty.html" class="tsd-signature-type">InterfaceProperty</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L82">lib/ui/interfaceManager.ts:82</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>property: <a href="../interfaces/interfaceproperty.html" class="tsd-signature-type">InterfaceProperty</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="addstep" class="tsd-anchor"></a>
<h3>add<wbr>Step</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Step<span class="tsd-signature-symbol">(</span>stepName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L171">lib/ui/interfaceManager.ts:171</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a user interface step.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>stepName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>callback: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Parameters: WebhookJob, WebhookInterface, Step, Done callback</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js"> manager.addStep(<span class="hljs-string">"Check job number"</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">webhookJob, webhookInterface, step, done</span>)</span>{
<span class="hljs-keyword">if</span>(webhookJob.getQueryStringValue(<span class="hljs-string">"job_number"</span>)){
webhookInterface.addField({
<span class="hljs-attr">id</span>: <span class="hljs-string">"something_else"</span>,
<span class="hljs-attr">_name</span>: <span class="hljs-string">"Some other field"</span>,
<span class="hljs-attr">type</span>: <span class="hljs-string">"text"</span>,
<span class="hljs-attr">description</span>: <span class="hljs-string">"Thanks for adding a job number!"</span>
});
step.complete = <span class="hljs-literal">true</span>; <span class="hljs-comment">// Mark step as complete</span>
done(); <span class="hljs-comment">// Callback to do next step or send response if complete</span>
}
});
</code></pre>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="checknest" class="tsd-anchor"></a>
<h3>check<wbr>Nest</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">check<wbr>Nest<span class="tsd-signature-symbol">(</span>nest<span class="tsd-signature-symbol">: </span><a href="foldernest.html" class="tsd-signature-type">FolderNest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L252">lib/ui/interfaceManager.ts:252</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds pending jobs to the interfaces job list.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nest: <a href="foldernest.html" class="tsd-signature-type">FolderNest</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getinterface" class="tsd-anchor"></a>
<h3>get<wbr>Interface</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Interface<span class="tsd-signature-symbol">(</span>sessionId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L218">lib/ui/interfaceManager.ts:218</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Find or return a new webhook interface instance.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> sessionId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="initmetadata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> init<wbr>Metadata</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">init<wbr>Metadata<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L53">lib/ui/interfaceManager.ts:53</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="removeinterfaceinstance" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> remove<wbr>Interface<wbr>Instance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Interface<wbr>Instance<span class="tsd-signature-symbol">(</span>wi<span class="tsd-signature-symbol">: </span><a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/interfaceManager.ts#L200">lib/ui/interfaceManager.ts:200</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>wi: <a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="interfacemanager.html" class="tsd-kind-icon">Interface<wbr>Manager</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="interfacemanager.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_checkpointnest" class="tsd-kind-icon">_checkpoint<wbr>Nest</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_fields" class="tsd-kind-icon">_fields</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_handlerequest" class="tsd-kind-icon">_handle<wbr>Request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_interfaceinstances" class="tsd-kind-icon">_interface<wbr>Instances</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_metadata" class="tsd-kind-icon">_metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_nest" class="tsd-kind-icon">_nest</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#_steps" class="tsd-kind-icon">_steps</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="interfacemanager.html#checkpointnest" class="tsd-kind-icon">checkpoint<wbr>Nest</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#customhandlerequest" class="tsd-kind-icon">custom<wbr>Handle<wbr>Request</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="interfacemanager.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#fields" class="tsd-kind-icon">fields</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#interfaceinstances" class="tsd-kind-icon">interface<wbr>Instances</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="interfacemanager.html#interfaceproperties" class="tsd-kind-icon">interface<wbr>Properties</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="interfacemanager.html#metadata" class="tsd-kind-icon">metadata</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#nest" class="tsd-kind-icon">nest</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="interfacemanager.html#steps" class="tsd-kind-icon">steps</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="interfacemanager.html#tooltip" class="tsd-kind-icon">tooltip</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="interfacemanager.html#addfield" class="tsd-kind-icon">add<wbr>Field</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#addinterfaceinstance" class="tsd-kind-icon">add<wbr>Interface<wbr>Instance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="interfacemanager.html#addinterfaceproperty" class="tsd-kind-icon">add<wbr>Interface<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="interfacemanager.html#addstep" class="tsd-kind-icon">add<wbr>Step</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="interfacemanager.html#checknest" class="tsd-kind-icon">check<wbr>Nest</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="interfacemanager.html#getinterface" class="tsd-kind-icon">get<wbr>Interface</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#initmetadata" class="tsd-kind-icon">init<wbr>Metadata</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="interfacemanager.html#removeinterfaceinstance" class="tsd-kind-icon">remove<wbr>Interface<wbr>Instance</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>