@octalmage/node-appletv

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Events | node-appletv</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">node-appletv</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-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="../modules/_lib_connection_.html">"lib/connection"</a> </li> <li> <a href="../classes/_lib_connection_.connection.html">Connection</a> </li> <li> <a href="_lib_connection_.connection.events.html">Events</a> </li> </ul> <h1>Interface Events</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Events</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="_lib_connection_.connection.events.html#close" class="tsd-kind-icon">close</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_connection_.connection.events.html#connect" class="tsd-kind-icon">connect</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_connection_.connection.events.html#debug" class="tsd-kind-icon">debug</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_connection_.connection.events.html#error" class="tsd-kind-icon">error</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_lib_connection_.connection.events.html#message" class="tsd-kind-icon">message</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="close" class="tsd-anchor"></a> <h3>close</h3> <div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/connection.ts#L223">lib/connection.ts:223</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="connect" class="tsd-anchor"></a> <h3>connect</h3> <div class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/connection.ts#L221">lib/connection.ts:221</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="debug" class="tsd-anchor"></a> <h3>debug</h3> <div class="tsd-signature tsd-kind-icon">debug<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/edc1591/node-appletv/blob/c47b9a3/src/lib/connection.ts#L225">lib/connection.ts:225</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="error" class="tsd-anchor"></a> <h3>error</h3> <div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/connection.ts#L224">lib/connection.ts:224</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="message" class="tsd-anchor"></a> <h3>message</h3> <div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <a href="../classes/_lib_message_.message.html" class="tsd-signature-type">Message</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edc1591/node-appletv/blob/c47b9a3/src/lib/connection.ts#L222">lib/connection.ts:222</a></li> </ul> </aside> </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=" tsd-kind-external-module"> <a href="../modules/_bin_index_.html">"bin/index"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_bin_pair_.html">"bin/pair"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_bin_scan_.html">"bin/scan"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_appletv_.html">"lib/appletv"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_browser_.html">"lib/browser"</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_lib_connection_.html">"lib/connection"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_credentials_.html">"lib/credentials"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_message_.html">"lib/message"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_now_playing_info_.html">"lib/now-<wbr>playing-<wbr>info"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_pairing_.html">"lib/pairing"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_supported_command_.html">"lib/supported-<wbr>command"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_typed_events_.html">"lib/typed-<wbr>events"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_util_encryption_.html">"lib/util/encryption"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_util_number_.html">"lib/util/number"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_util_tlv_.html">"lib/util/tlv"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_lib_verifier_.html">"lib/verifier"</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 tsd-parent-kind-external-module"> <a href="../classes/_lib_connection_.connection.html" class="tsd-kind-icon">Connection</a> <ul> <li class="current tsd-kind-interface tsd-parent-kind-class"> <a href="_lib_connection_.connection.events.html" class="tsd-kind-icon">Events</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_lib_connection_.connection.events.html#close" class="tsd-kind-icon">close</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_lib_connection_.connection.events.html#connect" class="tsd-kind-icon">connect</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_lib_connection_.connection.events.html#debug" class="tsd-kind-icon">debug</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_lib_connection_.connection.events.html#error" class="tsd-kind-icon">error</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_lib_connection_.connection.events.html#message" class="tsd-kind-icon">message</a> </li> </ul> </li> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="../classes/_lib_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#device" class="tsd-kind-icon">device</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#isopen" class="tsd-kind-icon">is<wbr>Open</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a href="../classes/_lib_connection_.connection.html#defaultmaxlisteners" class="tsd-kind-icon">default<wbr>Max<wbr>Listeners</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#_on" class="tsd-kind-icon">_on</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#close" class="tsd-kind-icon">close</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#emit" class="tsd-kind-icon">emit</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#eventnames" class="tsd-kind-icon">event<wbr>Names</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#listeners" class="tsd-kind-icon">listeners</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#on" class="tsd-kind-icon">on</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#once" class="tsd-kind-icon">once</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#open" class="tsd-kind-icon">open</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#prependlistener" class="tsd-kind-icon">prepend<wbr>Listener</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#prependoncelistener" class="tsd-kind-icon">prepend<wbr>Once<wbr>Listener</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#send" class="tsd-kind-icon">send</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="../classes/_lib_connection_.connection.html#sendblank" class="tsd-kind-icon">send<wbr>Blank</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"> <a href="../classes/_lib_connection_.connection.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"> <a href="../classes/_lib_connection_.connection.html#listenercount-1" class="tsd-kind-icon">listener<wbr>Count</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_lib_connection_.messagecallback.html" class="tsd-kind-icon">Message<wbr>Callback</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>