typed-slack

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Attachment | typed-slack</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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">typed-slack</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> </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="../modules/_typed_slack_.html">"typed-slack"</a> </li> <li> <a href="_typed_slack_.attachment.html">Attachment</a> </li> </ul> <h1>Interface Attachment</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>Attaching content and links to messages <a href="https://api.slack.com/docs/message-attachments">https://api.slack.com/docs/message-attachments</a></p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Attachment</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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#author_icon" class="tsd-kind-icon">author_<wbr>icon</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#author_link" class="tsd-kind-icon">author_<wbr>link</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#author_name" class="tsd-kind-icon">author_<wbr>name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#color" class="tsd-kind-icon">color</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#fallback" class="tsd-kind-icon">fallback</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#fields" class="tsd-kind-icon">fields</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#footer" class="tsd-kind-icon">footer</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#footer_icon" class="tsd-kind-icon">footer_<wbr>icon</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#image_url" class="tsd-kind-icon">image_<wbr>url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#pretext" class="tsd-kind-icon">pretext</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#text" class="tsd-kind-icon">text</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#thumb_url" class="tsd-kind-icon">thumb_<wbr>url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#title" class="tsd-kind-icon">title</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#title_link" class="tsd-kind-icon">title_<wbr>link</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_typed_slack_.attachment.html#ts" class="tsd-kind-icon">ts</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="author_icon" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> author_<wbr>icon</h3> <div class="tsd-signature tsd-kind-icon">author_<wbr>icon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L56">typed-slack.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A valid URL that displays a small 16x16px image to the left of the author_name text. Will only work if author_name is present.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="author_link" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> author_<wbr>link</h3> <div class="tsd-signature tsd-kind-icon">author_<wbr>link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L52">typed-slack.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A valid URL that will hyperlink the author_name text mentioned above. Will only work if author_name is present.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="author_name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> author_<wbr>name</h3> <div class="tsd-signature tsd-kind-icon">author_<wbr>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L48">typed-slack.ts:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Small text used to display the author's name.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="color" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> color</h3> <div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <a href="../enums/_typed_slack_.color.html" class="tsd-signature-type">Color</a><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L40">typed-slack.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Like traffic signals, color-coding messages can quickly communicate intent and help separate them from the flow of other messages in the timeline. An optional value that can either be one of good, warning, danger, or any hex color code (eg. #439FE0). This value is used to color the border along the left side of the message attachment.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="fallback" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fallback</h3> <div class="tsd-signature tsd-kind-icon">fallback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L35">typed-slack.ts:35</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A plain-text summary of the attachment. This text will be used in clients that don't show formatted text (eg. IRC, mobile notifications) and should not contain any markup.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="fields" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> fields</h3> <div class="tsd-signature tsd-kind-icon">fields<span class="tsd-signature-symbol">:</span> <a href="_typed_slack_.field.html" class="tsd-signature-type">Field</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L72">typed-slack.ts:72</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Fields are defined as an array, and hashes contained within it will be displayed in a table inside the message attachment.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="footer" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> footer</h3> <div class="tsd-signature tsd-kind-icon">footer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L87">typed-slack.ts:87</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add some brief text to help contextualize and identify an attachment. Limited to 300 characters, and may be truncated further when displayed to users in environments with limited screen real estate.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="footer_icon" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> footer_<wbr>icon</h3> <div class="tsd-signature tsd-kind-icon">footer_<wbr>icon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L93">typed-slack.ts:93</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>To render a small icon beside your footer text, provide a publicly accessible URL string in the footer_icon field. You must also provide a footer for the field to be recognized. We'll render what you provide at 16px by 16px. It's best to use an image that is similarly sized. Example: "<a href="https://platform.slack-edge.com/img/default_application_icon.png"">https://platform.slack-edge.com/img/default_application_icon.png"</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="image_url" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> image_<wbr>url</h3> <div class="tsd-signature tsd-kind-icon">image_<wbr>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L77">typed-slack.ts:77</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A valid URL to an image file that will be displayed inside a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. Large images will be resized to a maximum width of 400px or a maximum height of 500px, while still maintaining the original aspect ratio.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="pretext" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> pretext</h3> <div class="tsd-signature tsd-kind-icon">pretext<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L44">typed-slack.ts:44</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is optional text that appears above the message attachment block.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="text" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> text</h3> <div class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L68">typed-slack.ts:68</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is the main text in a message attachment, and can contain standard message markup. The content will automatically collapse if it contains 700+ characters or 5+ linebreaks, and will display a "Show more..." link to expand the content. Links posted in the text field will not unfurl.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="thumb_url" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> thumb_<wbr>url</h3> <div class="tsd-signature tsd-kind-icon">thumb_<wbr>url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L83">typed-slack.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP. The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. The filesize of the image must also be less than 500 KB. For best results, please use images that are already 75px by 75px.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="title" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3> <div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L60">typed-slack.ts:60</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The title is displayed as larger, bold text near the top of a message attachment.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="title_link" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> title_<wbr>link</h3> <div class="tsd-signature tsd-kind-icon">title_<wbr>link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><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/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L64">typed-slack.ts:64</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>By passing a valid URL in the title_link parameter (optional), the title text will be hyperlinked.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="ts" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3> <div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/starhoshi/typed-slack/blob/30beb58/src/typed-slack.ts#L100">typed-slack.ts:100</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Does your attachment relate to something happening at a specific time? By providing the ts field with an integer value in "epoch time", the attachment will display an additional timestamp value as part of the attachment's footer. Use ts when referencing articles or happenings. Your message will have its own timestamp when published. Example: Providing 123456789 would result in a rendered timestamp of Nov 29th, 1973.</p> </div> </div> </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> <li class="current tsd-kind-external-module"> <a href="../modules/_typed_slack_.html">"typed-<wbr>slack"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-external-module"> <a href="../enums/_typed_slack_.color.html" class="tsd-kind-icon">Color</a> </li> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_typed_slack_.incomingwebhook.html" class="tsd-kind-icon">Incoming<wbr>Webhook</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-external-module"> <a href="_typed_slack_.attachment.html" class="tsd-kind-icon">Attachment</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#author_icon" class="tsd-kind-icon">author_<wbr>icon</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#author_link" class="tsd-kind-icon">author_<wbr>link</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#author_name" class="tsd-kind-icon">author_<wbr>name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#color" class="tsd-kind-icon">color</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#fallback" class="tsd-kind-icon">fallback</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#fields" class="tsd-kind-icon">fields</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#footer" class="tsd-kind-icon">footer</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#footer_icon" class="tsd-kind-icon">footer_<wbr>icon</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#image_url" class="tsd-kind-icon">image_<wbr>url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#pretext" class="tsd-kind-icon">pretext</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#text" class="tsd-kind-icon">text</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#thumb_url" class="tsd-kind-icon">thumb_<wbr>url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#title" class="tsd-kind-icon">title</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#title_link" class="tsd-kind-icon">title_<wbr>link</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_typed_slack_.attachment.html#ts" class="tsd-kind-icon">ts</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_typed_slack_.field.html" class="tsd-kind-icon">Field</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="_typed_slack_.incomingwebhookoptions.html" class="tsd-kind-icon">Incoming<wbr>Webhook<wbr>Options</a> </li> </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.org/" 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>