antfarm
Version:
File automation framework for ants.
1,001 lines • 56.9 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebhookInterface | 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="webhookinterface.html">WebhookInterface</a>
</li>
</ul>
<h1>Class WebhookInterface</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>A webhook interface instance, tied to a particular session.
Within interface steps, you can use these methods directly to alter the schema being returned to the user interface.</p>
<h4 id="example">Example</h4>
<pre><code class="lang-js"><span class="hljs-keyword">var</span> manager = webhook.getInterfaceManager();
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</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>
}
});
</code></pre>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">WebhookInterface</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="webhookinterface.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="webhookinterface.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="webhookinterface.html#_fields" class="tsd-kind-icon">_fields</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.html#_metadata" class="tsd-kind-icon">_metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.html#_nest" class="tsd-kind-icon">_nest</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.html#_sessionid" class="tsd-kind-icon">_session<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.html#_steps" class="tsd-kind-icon">_steps</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.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="webhookinterface.html#checkpointnest" class="tsd-kind-icon">checkpoint<wbr>Nest</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="webhookinterface.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="webhookinterface.html#fields" class="tsd-kind-icon">fields</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="webhookinterface.html#interfaceproperties" class="tsd-kind-icon">interface<wbr>Properties</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="webhookinterface.html#metadata" class="tsd-kind-icon">metadata</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="webhookinterface.html#nest" class="tsd-kind-icon">nest</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="webhookinterface.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="webhookinterface.html#steps" class="tsd-kind-icon">steps</a></li>
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="webhookinterface.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="webhookinterface.html#addfield" class="tsd-kind-icon">add<wbr>Field</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#addinterfaceproperty" class="tsd-kind-icon">add<wbr>Interface<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#addstep" class="tsd-kind-icon">add<wbr>Step</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#completestep" class="tsd-kind-icon">complete<wbr>Step</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#getfield" class="tsd-kind-icon">get<wbr>Field</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#getjobs" class="tsd-kind-icon">get<wbr>Jobs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#gettransportinterface" class="tsd-kind-icon">get<wbr>Transport<wbr>Interface</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="webhookinterface.html#initmetadata" class="tsd-kind-icon">init<wbr>Metadata</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webhookinterface.html#removestep" class="tsd-kind-icon">remove<wbr>Step</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>Webhook<wbr>Interface<span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="environment.html" class="tsd-signature-type">Environment</a>, nest<span class="tsd-signature-symbol">: </span><a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</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/webhookInterface.ts#L42">lib/ui/webhookInterface.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructor</p>
</div>
</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>nest: <a href="webhooknest.html" class="tsd-signature-type">WebhookNest</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="webhookinterface.html" class="tsd-signature-type">WebhookInterface</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/webhookInterface.ts#L39">lib/ui/webhookInterface.ts:39</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/webhookInterface.ts#L36">lib/ui/webhookInterface.ts:36</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/webhookInterface.ts#L42">lib/ui/webhookInterface.ts:42</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/webhookInterface.ts#L38">lib/ui/webhookInterface.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="_sessionid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _session<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">_session<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/webhookInterface.ts#L41">lib/ui/webhookInterface.ts:41</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/webhookInterface.ts#L40">lib/ui/webhookInterface.ts:40</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/webhookInterface.ts#L37">lib/ui/webhookInterface.ts:37</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/webhookInterface.ts#L219">lib/ui/webhookInterface.ts:219</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the checkpoint nest.</p>
</div>
</div>
<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/webhookInterface.ts#L215">lib/ui/webhookInterface.ts:215</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the checkpoint nest.</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 class="lead">
</div>
</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-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/webhookInterface.ts#L82">lib/ui/webhookInterface.ts:82</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-accessor tsd-parent-kind-class">
<a name="fields" class="tsd-anchor"></a>
<h3>fields</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> 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>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> fields<span class="tsd-signature-symbol">(</span>fields<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-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/webhookInterface.ts#L168">lib/ui/webhookInterface.ts:168</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an array of all of the 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>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dominickp/antfarm/blob/2c87e64/src/lib/ui/webhookInterface.ts#L160">lib/ui/webhookInterface.ts:160</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Overwrites fields with a clone.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fields: <a href="../interfaces/fieldoptions.html" class="tsd-signature-type">FieldOptions</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-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/webhookInterface.ts#L94">lib/ui/webhookInterface.ts:94</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/webhookInterface.ts#L64">lib/ui/webhookInterface.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets a cloned instance of metadata.</p>
</div>
</div>
<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/webhookInterface.ts#L72">lib/ui/webhookInterface.ts:72</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets a cloned instance of metadata.</p>
</div>
</div>
<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>
<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-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/webhookInterface.ts#L110">lib/ui/webhookInterface.ts:110</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="sessionid" class="tsd-anchor"></a>
<h3>session<wbr>Id</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> sessionId<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/webhookInterface.ts#L102">lib/ui/webhookInterface.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the session id. Used to match to interface instanced within the manager.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="steps" class="tsd-anchor"></a>
<h3>steps</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> steps<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>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> steps<span class="tsd-signature-symbol">(</span>steps<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/webhookInterface.ts#L264">lib/ui/webhookInterface.ts:264</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an array of instance steps.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></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/webhookInterface.ts#L272">lib/ui/webhookInterface.ts:272</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Overwrite the instant steps.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>steps: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</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-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/webhookInterface.ts#L86">lib/ui/webhookInterface.ts:86</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/webhookInterface.ts#L118">lib/ui/webhookInterface.ts:118</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">
<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/webhookInterface.ts#L90">lib/ui/webhookInterface.ts:90</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/webhookInterface.ts#L228">lib/ui/webhookInterface.ts:228</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">
</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="completestep" class="tsd-anchor"></a>
<h3>complete<wbr>Step</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">complete<wbr>Step<span class="tsd-signature-symbol">(</span>step<span class="tsd-signature-symbol">: </span><a href="step.html" class="tsd-signature-type">Step</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/webhookInterface.ts#L240">lib/ui/webhookInterface.ts:240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Mark a step as complete and remove it from the interface.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>step: <a href="step.html" class="tsd-signature-type">Step</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">
<a name="getfield" class="tsd-anchor"></a>
<h3>get<wbr>Field</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Field<span class="tsd-signature-symbol">(</span>fieldId<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/webhookInterface.ts#L151">lib/ui/webhookInterface.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get an existing field from the interface to modify its properties.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fieldId: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
<h4 id="example">Example</h4>
<pre><code class="lang-js">im.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.getParameter(<span class="hljs-string">"job_number"</span>).length == <span class="hljs-number">6</span>) {
<span class="hljs-comment">// Make job number read only</span>
<span class="hljs-keyword">var</span> jobNumberField = webhookInterface.getField(<span class="hljs-string">"job_number"</span>);
jobNumberField.readonly = <span class="hljs-literal">true</span>;
<span class="hljs-comment">// Complete step</span>
webhookInterface.completeStep(step);
} <span class="hljs-keyword">else</span> {
step.failure = <span class="hljs-string">"Job number was not 6 characters."</span>;
}
done();
});
</code></pre>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getjobs" class="tsd-anchor"></a>
<h3>get<wbr>Jobs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Jobs<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="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</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/webhookInterface.ts#L202">lib/ui/webhookInterface.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns checked jobs.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="filejob.html" class="tsd-signature-type">FileJob</a><span class="tsd-signature-symbol"> | </span><a href="folderjob.html" class="tsd-signature-type">FolderJob</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettransportinterface" class="tsd-anchor"></a>
<h3>get<wbr>Transport<wbr>Interface</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Transport<wbr>Interface<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</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/webhookInterface.ts#L176">lib/ui/webhookInterface.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the interface for transport.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>fields<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></h5>
</li>
<li class="tsd-parameter">
<h5>held<wbr>Jobs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li class="tsd-parameter">
<h5>metadata<span class="tsd-signature-symbol">: </span><a href="../interfaces/interfacemetadata.html" class="tsd-signature-type">InterfaceMetadata</a></h5>
</li>
<li class="tsd-parameter">
<h5>session<wbr>Id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>steps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
</li>
</ul>
</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/webhookInterface.ts#L58">lib/ui/webhookInterface.ts:58</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">
<a name="removestep" class="tsd-anchor"></a>
<h3>remove<wbr>Step</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">remove<wbr>Step<span class="tsd-signature-symbol">(</span>step<span class="tsd-signature-symbol">: </span><a href="step.html" class="tsd-signature-type">Step</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/webhookInterface.ts#L256">lib/ui/webhookInterface.ts:256</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of completeStep.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>step: <a href="step.html" class="tsd-signature-type">Step</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>
</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="webhookinterface.html" class="tsd-kind-icon">Webhook<wbr>Interface</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="webhookinterface.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.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="webhookinterface.html#_fields" class="tsd-kind-icon">_fields</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#_metadata" class="tsd-kind-icon">_metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#_nest" class="tsd-kind-icon">_nest</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#_sessionid" class="tsd-kind-icon">_session<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#_steps" class="tsd-kind-icon">_steps</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#e" class="tsd-kind-icon">e</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="webhookinterface.html#checkpointnest" class="tsd-kind-icon">checkpoint<wbr>Nest</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="webhookinterface.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="webhookinterface.html#fields" class="tsd-kind-icon">fields</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="webhookinterface.html#interfaceproperties" class="tsd-kind-icon">interface<wbr>Properties</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="webhookinterface.html#metadata" class="tsd-kind-icon">metadata</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="webhookinterface.html#nest" class="tsd-kind-icon">nest</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="webhookinterface.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a>
</li>
<li class=" tsd-kind-accessor tsd-parent-kind-class">
<a href="webhookinterface.html#steps" class="tsd-kind-icon">steps</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="webhookinterface.html#tooltip" class="tsd-kind-icon">tooltip</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#addfield" class="tsd-kind-icon">add<wbr>Field</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#addinterfaceproperty" class="tsd-kind-icon">add<wbr>Interface<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#addstep" class="tsd-kind-icon">add<wbr>Step</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#completestep" class="tsd-kind-icon">complete<wbr>Step</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#getfield" class="tsd-kind-icon">get<wbr>Field</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#getjobs" class="tsd-kind-icon">get<wbr>Jobs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#gettransportinterface" class="tsd-kind-icon">get<wbr>Transport<wbr>Interface</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="webhookinterface.html#initmetadata" class="tsd-kind-icon">init<wbr>Metadata</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webhookinterface.html#removestep" class="tsd-kind-icon">remove<wbr>Step</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>