@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>RealTimeUndefinedEvents | Convergence JavaScript Client API Documentation</title> <meta name="description" content="Documentation for Convergence JavaScript Client API Documentation"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/ico" href="https://convergence.io/assets/img/favicon/favicon.ico" sizes="48x48"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-96x96.png" sizes="96x96">  <script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=3ee5157d-2fc2-4b08-b6c7-d5fad0533179"> </script>  </head> <body> <header> <div class="tsd-page-toolbar convergence-header"> <div class="container"> <div class="flex-content"> <a href="../index.html" class="header-brand"> <img src=../assets/images/convergence-logo.png /> <span class="brand-title brand-copy">Convergence JavaScript Client API Documentation</span> <span class="version">1.0.0-rc.12</span> </a> <div class="links brand-copy"> <div class="link"> <a href="https://docs.convergence.io/guide/">Dev Guide</a> </div> <div class="link"> <a href="https://examples.convergence.io">Examples</a> </div> <div class="link"> <a href="https://convergence.io/support/">Support</a> </div> </div> </div> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" 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> </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"> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</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">Index</a> </li> <li> <a href="../modules/real_time_data.html">Real Time Data</a> </li> <li> <a href="real_time_data.realtimeundefinedevents.html">RealTimeUndefinedEvents</a> </li> </ul> <h1>Interface RealTimeUndefinedEvents</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> <a href="real_time_data.observableundefinedevents.html" class="tsd-signature-type">ObservableUndefinedEvents</a> <ul class="tsd-hierarchy"> <li> <span class="target">RealTimeUndefinedEvents</span> </li> </ul> </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 tsd-is-inherited"> <h3>Events</h3> <ul class="tsd-index-list"> <li class="tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"><a href="real_time_data.realtimeundefinedevents.html#detached" class="tsd-kind-icon">DETACHED</a></li> <li class="tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"><a href="real_time_data.realtimeundefinedevents.html#model_changed" class="tsd-kind-icon">MODEL_<wbr>CHANGED</a></li> <li class="tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"><a href="real_time_data.realtimeundefinedevents.html#reference" class="tsd-kind-icon">REFERENCE</a></li> <li class="tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"><a href="real_time_data.realtimeundefinedevents.html#value" class="tsd-kind-icon">VALUE</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Events</h2> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a name="detached" class="tsd-anchor"></a> <h3>DETACHED</h3> <div class="tsd-signature tsd-kind-icon">DETACHED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="real_time_data.observableobjectevents.html">ObservableObjectEvents</a>.<a href="real_time_data.observableobjectevents.html#detached">DETACHED</a></p> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Emitted when this element becomes detached, which typically happens when the element is removed from its parent. An <a href="../classes/real_time_data.elementdetachedevent.html">ElementDetachedEvent</a> is the actual emitted event.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a name="model_changed" class="tsd-anchor"></a> <h3>MODEL_<wbr>CHANGED</h3> <div class="tsd-signature tsd-kind-icon">MODEL_<wbr>CHANGED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="real_time_data.observableobjectevents.html">ObservableObjectEvents</a>.<a href="real_time_data.observableobjectevents.html#model_changed">MODEL_CHANGED</a></p> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Emitted when any child element of this element has a change. See <a href="../classes/real_time_data.modelchangedevent.html">ModelChangedEvent</a> for details.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a name="reference" class="tsd-anchor"></a> <h3>REFERENCE</h3> <div class="tsd-signature tsd-kind-icon">REFERENCE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="real_time_data.observableobjectevents.html">ObservableObjectEvents</a>.<a href="real_time_data.observableobjectevents.html#reference">REFERENCE</a></p> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Emitted when a remote <a href="https://docs.convergence.io/guide/models/references/references.html">reference</a> is created on this <a href="../classes/real_time_data.realtimeelement.html">RealTimeElement</a>. See <a href="../classes/real_time_data.remotereferencecreatedevent.html">RemoteReferenceCreatedEvent</a> for the actual emitted event.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a name="value" class="tsd-anchor"></a> <h3>VALUE</h3> <div class="tsd-signature tsd-kind-icon">VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="real_time_data.observableelementevents.html">ObservableElementEvents</a>.<a href="real_time_data.observableelementevents.html#value">VALUE</a></p> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Emitted when the <a href="../classes/real_time_data.realtimeelement.html#value">value</a> of a <a href="../classes/real_time_data.realtimeelement.html">RealTimeElement</a> is set. See the <a href="real_time_data.ivaluechangedevent.html">IValueChangedEvent</a> interface.</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>Index</em></a> </li> <li class="modules-label">Modules</li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/activities.html">Activities</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/chat.html">Chat</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/connection_and_authentication.html">Connection and <wbr>Authentication</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/offline.html">Offline</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/presence.html">Presence</a></span> </li> <li class="current tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/real_time_data.html">Real <wbr>Time <wbr>Data</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/users_and_identity.html">Users and <wbr>Identity</a></span> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> <a href="real_time_data.realtimeundefinedevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Undefined<wbr>Events</a> <ul> <li class=" tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a href="real_time_data.realtimeundefinedevents.html#detached" class="tsd-kind-icon">DETACHED</a> </li> <li class=" tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a href="real_time_data.realtimeundefinedevents.html#model_changed" class="tsd-kind-icon">MODEL_<wbr>CHANGED</a> </li> <li class=" tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a href="real_time_data.realtimeundefinedevents.html#reference" class="tsd-kind-icon">REFERENCE</a> </li> <li class=" tsd-kind-event tsd-parent-kind-interface tsd-is-inherited"> <a href="real_time_data.realtimeundefinedevents.html#value" class="tsd-kind-icon">VALUE</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <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> </ul> <ul class="tsd-legend"> <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-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <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> </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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-84372428-3', 'auto'); ga('send', 'pageview'); </script> </body> </html>