UNPKG

@convergence/convergence

Version:
490 lines 98.6 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Real Time Data | 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"> <!-- Start of convergencelabs Zendesk Widget script --> <script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=3ee5157d-2fc2-4b08-b6c7-d5fad0533179"> </script> <!-- End of convergencelabs Zendesk Widget 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="real_time_data.html">Real Time Data</a> </li> </ul> <h1>Module Real Time Data</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>When considering implementing real-time collaboration, most developers think (and only think!) about the various algorithms for synchronizing data. This indeed is a core consideration for collaborative editing systems, and many tomes have been written about it. Convergence&#39;s main goal is to insulate developers from the difficulties of implementing Operational Transformation. It does this by supporting a strict set of data: JSON.</p> </div> <p>See our <a href="https://docs.convergence.io/guide/models/overview.html">developer guide</a> for additional information.</p> <p>To get started with Real Time Data, get an instance of the <a href="../classes/real_time_data.modelservice.html">ModelService</a> from the <a href="../classes/convergencedomain.html">ConvergenceDomain</a>.</p> </div> </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>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalarrayevents.html" class="tsd-kind-icon">Historical<wbr>Array<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalbooleanevents.html" class="tsd-kind-icon">Historical<wbr>Boolean<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/real_time_data.historicalcontainerelement.html" class="tsd-kind-icon">Historical<wbr>Container<wbr>Element</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicaldateevents.html" class="tsd-kind-icon">Historical<wbr>Date<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalelementevents.html" class="tsd-kind-icon">Historical<wbr>Element<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalmodelevents.html" class="tsd-kind-icon">Historical<wbr>Model<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalnullevents.html" class="tsd-kind-icon">Historical<wbr>Null<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalnumberevents.html" class="tsd-kind-icon">Historical<wbr>Number<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalobjectevents.html" class="tsd-kind-icon">Historical<wbr>Object<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalstringevents.html" class="tsd-kind-icon">Historical<wbr>String<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.historicalundefinedevents.html" class="tsd-kind-icon">Historical<wbr>Undefined<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.iarrayvalue.html" class="tsd-kind-icon">IArray<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.iautocreatemodeloptions.html" class="tsd-kind-icon">IAuto<wbr>Create<wbr>Model<wbr>Options</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.ibooleanvalue.html" class="tsd-kind-icon">IBoolean<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.iconvergencemodelvalueevent.html" class="tsd-kind-icon">IConvergence<wbr>Model<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.icreatemodeloptions.html" class="tsd-kind-icon">ICreate<wbr>Model<wbr>Options</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.idatavalue.html" class="tsd-kind-icon">IData<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.idatevalue.html" class="tsd-kind-icon">IDate<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.imodelevent.html" class="tsd-kind-icon">IModel<wbr>Event</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.imodelpermissions.html" class="tsd-kind-icon">IModel<wbr>Permissions</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.imodelserviceevents.html" class="tsd-kind-icon">IModel<wbr>Service<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.inullvalue.html" class="tsd-kind-icon">INull<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.inumbervalue.html" class="tsd-kind-icon">INumber<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.iobjectvalue.html" class="tsd-kind-icon">IObject<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.istringvalue.html" class="tsd-kind-icon">IString<wbr>Value</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.ivaluechangedevent.html" class="tsd-kind-icon">IValue<wbr>Changed<wbr>Event</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.indexrange.html" class="tsd-kind-icon">Index<wbr>Range</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.modeldata.html" class="tsd-kind-icon">Model<wbr>Data</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.modelreferenceevents.html" class="tsd-kind-icon">Model<wbr>Reference<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.modelreferencetypes.html" class="tsd-kind-icon">Model<wbr>Reference<wbr>Types</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablearray.html" class="tsd-kind-icon">Observable<wbr>Array</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablearrayevents.html" class="tsd-kind-icon">Observable<wbr>Array<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableboolean.html" class="tsd-kind-icon">Observable<wbr>Boolean</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablebooleanevents.html" class="tsd-kind-icon">Observable<wbr>Boolean<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/real_time_data.observablecontainerelement.html" class="tsd-kind-icon">Observable<wbr>Container<wbr>Element</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observabledate.html" class="tsd-kind-icon">Observable<wbr>Date</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observabledateevents.html" class="tsd-kind-icon">Observable<wbr>Date<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/real_time_data.observableelement.html" class="tsd-kind-icon">Observable<wbr>Element</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableelementevents.html" class="tsd-kind-icon">Observable<wbr>Element<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablemodel.html" class="tsd-kind-icon">Observable<wbr>Model</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablemodelevents.html" class="tsd-kind-icon">Observable<wbr>Model<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablenull.html" class="tsd-kind-icon">Observable<wbr>Null</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablenullevents.html" class="tsd-kind-icon">Observable<wbr>Null<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablenumber.html" class="tsd-kind-icon">Observable<wbr>Number</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablenumberevents.html" class="tsd-kind-icon">Observable<wbr>Number<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableobject.html" class="tsd-kind-icon">Observable<wbr>Object</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableobjectevents.html" class="tsd-kind-icon">Observable<wbr>Object<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablestring.html" class="tsd-kind-icon">Observable<wbr>String</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observablestringevents.html" class="tsd-kind-icon">Observable<wbr>String<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableundefined.html" class="tsd-kind-icon">Observable<wbr>Undefined</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.observableundefinedevents.html" class="tsd-kind-icon">Observable<wbr>Undefined<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimearrayevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Array<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimebooleanevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Boolean<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/real_time_data.realtimecontainerelement.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Container<wbr>Element</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimedateevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Date<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimeelementevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Element<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimemodelevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Model<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimenullevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Null<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimenumberevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Number<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimeobjectevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Object<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimestringevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>String<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.realtimeundefinedevents.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Undefined<wbr>Events</a></li> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/real_time_data.referencefilter.html" class="tsd-kind-icon">Reference<wbr>Filter</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#modeldatacallback" class="tsd-kind-icon">Model<wbr>Data<wbr>Callback</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#modeldatainitializer" class="tsd-kind-icon">Model<wbr>Data<wbr>Initializer</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#offlinemodeldownloadstatuschangetrigger" class="tsd-kind-icon">Offline<wbr>Model<wbr>Download<wbr>Status<wbr>Change<wbr>Trigger</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#path" class="tsd-kind-icon">Path</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#pathelement" class="tsd-kind-icon">Path<wbr>Element</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="real_time_data.html#referencetype" class="tsd-kind-icon">Reference<wbr>Type</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#modelserviceeventconstants" class="tsd-kind-icon">Model<wbr>Service<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observablearrayeventconstants" class="tsd-kind-icon">Observable<wbr>Array<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observableelementeventconstants" class="tsd-kind-icon">Observable<wbr>Element<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observablemodeleventconstants" class="tsd-kind-icon">Observable<wbr>Model<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observablenumbereventconstants" class="tsd-kind-icon">Observable<wbr>Number<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observableobjecteventconstants" class="tsd-kind-icon">Observable<wbr>Object<wbr>Event<wbr>Constants</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-module"><a href="real_time_data.html#observablestringeventconstants" class="tsd-kind-icon">Observable<wbr>String<wbr>Event<wbr>Constants</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.arrayinsertevent.html" class="tsd-kind-icon">Array<wbr>Insert<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.arrayremoveevent.html" class="tsd-kind-icon">Array<wbr>Remove<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.arrayreorderevent.html" class="tsd-kind-icon">Array<wbr>Reorder<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.arraysetevent.html" class="tsd-kind-icon">Array<wbr>Set<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.arraysetvalueevent.html" class="tsd-kind-icon">Array<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.booleansetvalueevent.html" class="tsd-kind-icon">Boolean<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.collaboratorclosedevent.html" class="tsd-kind-icon">Collaborator<wbr>Closed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.collaboratoropenedevent.html" class="tsd-kind-icon">Collaborator<wbr>Opened<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.datesetvalueevent.html" class="tsd-kind-icon">Date<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.elementdetachedevent.html" class="tsd-kind-icon">Element<wbr>Detached<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.elementreference.html" class="tsd-kind-icon">Element<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalarray.html" class="tsd-kind-icon">Historical<wbr>Array</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalboolean.html" class="tsd-kind-icon">Historical<wbr>Boolean</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicaldate.html" class="tsd-kind-icon">Historical<wbr>Date</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.historicalelement.html" class="tsd-kind-icon">Historical<wbr>Element</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalmodel.html" class="tsd-kind-icon">Historical<wbr>Model</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalnull.html" class="tsd-kind-icon">Historical<wbr>Null</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalnumber.html" class="tsd-kind-icon">Historical<wbr>Number</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalobject.html" class="tsd-kind-icon">Historical<wbr>Object</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalstring.html" class="tsd-kind-icon">Historical<wbr>String</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.historicalundefined.html" class="tsd-kind-icon">Historical<wbr>Undefined</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.indexreference.html" class="tsd-kind-icon">Index<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.localelementreference.html" class="tsd-kind-icon">Local<wbr>Element<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.localindexreference.html" class="tsd-kind-icon">Local<wbr>Index<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.localmodelreference.html" class="tsd-kind-icon">Local<wbr>Model<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.localpropertyreference.html" class="tsd-kind-icon">Local<wbr>Property<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.localrangereference.html" class="tsd-kind-icon">Local<wbr>Range<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelchangedevent.html" class="tsd-kind-icon">Model<wbr>Changed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelclosedevent.html" class="tsd-kind-icon">Model<wbr>Closed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelcollaborator.html" class="tsd-kind-icon">Model<wbr>Collaborator</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelcommittedevent.html" class="tsd-kind-icon">Model<wbr>Committed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modeldeletedevent.html" class="tsd-kind-icon">Model<wbr>Deleted<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelmodifiedevent.html" class="tsd-kind-icon">Model<wbr>Modified<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelofflineevent.html" class="tsd-kind-icon">Model<wbr>Offline<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelonlineevent.html" class="tsd-kind-icon">Model<wbr>Online<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelpermissionmanager.html" class="tsd-kind-icon">Model<wbr>Permission<wbr>Manager</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelpermissions.html" class="tsd-kind-icon">Model<wbr>Permissions</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelpermissionschangedevent.html" class="tsd-kind-icon">Model<wbr>Permissions<wbr>Changed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelreconnectingevent.html" class="tsd-kind-icon">Model<wbr>Reconnecting<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.modelreference.html" class="tsd-kind-icon">Model<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelresult.html" class="tsd-kind-icon">Model<wbr>Result</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.modelservice.html" class="tsd-kind-icon">Model<wbr>Service</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.numberdeltaevent.html" class="tsd-kind-icon">Number<wbr>Delta<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.numbersetvalueevent.html" class="tsd-kind-icon">Number<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.objectremoveevent.html" class="tsd-kind-icon">Object<wbr>Remove<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.objectsetevent.html" class="tsd-kind-icon">Object<wbr>Set<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.objectsetvalueevent.html" class="tsd-kind-icon">Object<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodeldeletedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Deleted<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodeldownloadedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Downloaded<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelpermissionsrevokedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Permissions<wbr>Revoked<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelstatuschangedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Status<wbr>Changed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsynccompletedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Sync<wbr>Completed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsyncerrorevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Sync<wbr>Error<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsyncstartedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Sync<wbr>Started<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelupdatedevent.html" class="tsd-kind-icon">Offline<wbr>Model<wbr>Updated<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsdownloadstartedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Download<wbr>Started<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsdownloadstatuschangedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Download<wbr>Status<wbr>Changed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelsdownloadstoppedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Download<wbr>Stopped<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelssyncabortedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Sync<wbr>Aborted<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelssynccompletedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Sync<wbr>Completed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelssyncprogressevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Sync<wbr>Progress<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.offlinemodelssyncstartedevent.html" class="tsd-kind-icon">Offline<wbr>Models<wbr>Sync<wbr>Started<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.propertyreference.html" class="tsd-kind-icon">Property<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.rangereference.html" class="tsd-kind-icon">Range<wbr>Reference</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimearray.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Array</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimeboolean.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Boolean</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimedate.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Date</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.realtimeelement.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Element</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimemodel.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Model</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimenull.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Null</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimenumber.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Number</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimeobject.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Object</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimestring.html" class="tsd-kind-icon">Real<wbr>Time<wbr>String</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.realtimeundefined.html" class="tsd-kind-icon">Real<wbr>Time<wbr>Undefined</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.referenceclearedevent.html" class="tsd-kind-icon">Reference<wbr>Cleared<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.referencedisposedevent.html" class="tsd-kind-icon">Reference<wbr>Disposed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/real_time_data.referencesetevent.html" class="tsd-kind-icon">Reference<wbr>Set<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.remotereferencecreatedevent.html" class="tsd-kind-icon">Remote<wbr>Reference<wbr>Created<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.remoteresynccompletedevent.html" class="tsd-kind-icon">Remote<wbr>Resync<wbr>Completed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.remoteresyncstartedevent.html" class="tsd-kind-icon">Remote<wbr>Resync<wbr>Started<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.resynccompletedevent.html" class="tsd-kind-icon">Resync<wbr>Completed<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.resyncerrorevent.html" class="tsd-kind-icon">Resync<wbr>Error<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.resyncstartedevent.html" class="tsd-kind-icon">Resync<wbr>Started<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.stringinsertevent.html" class="tsd-kind-icon">String<wbr>Insert<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.stringremoveevent.html" class="tsd-kind-icon">String<wbr>Remove<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.stringsetvalueevent.html" class="tsd-kind-icon">String<wbr>Set<wbr>Value<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.stringspliceevent.html" class="tsd-kind-icon">String<wbr>Splice<wbr>Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/real_time_data.versionchangedevent.html" class="tsd-kind-icon">Version<wbr>Changed<wbr>Event</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="modeldatacallback" class="tsd-anchor"></a> <h3>Model<wbr>Data<wbr>Callback</h3> <div class="tsd-signature tsd-kind-icon">Model<wbr>Data<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/real_time_data.modeldata.html" class="tsd-signature-type">ModelData</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A callback function that will result in some model data that will become the model&#39;s initial contents.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/real_time_data.modeldata.html" class="tsd-signature-type">ModelData</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <a href="../interfaces/real_time_data.modeldata.html" class="tsd-signature-type">ModelData</a></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="modeldatainitializer" class="tsd-anchor"></a> <h3>Model<wbr>Data<wbr>Initializer</h3> <div class="tsd-signature tsd-kind-icon">Model<wbr>Data<wbr>Initializer<span class="tsd-signature-symbol">:</span> <a href="../interfaces/real_time_data.modeldata.html" class="tsd-signature-type">ModelData</a><span class="tsd-signature-symbol"> | </span><a href="real_time_data.html#modeldatacallback" class="tsd-signature-type">ModelDataCallback</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Either some data or a callback returning data can be provided.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="offlinemodeldownloadstatuschangetrigger" class="tsd-anchor"></a> <h3>Offline<wbr>Model<wbr>Download<wbr>Status<wbr>Change<wbr>Trigger</h3> <div class="tsd-signature tsd-kind-icon">Offline<wbr>Model<wbr>Download<wbr>Status<wbr>Change<wbr>Trigger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"download"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"subscription_changed"</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Indicates what triggered the change to the download status. A value of &quot;download&quot; indicates that the change was triggered by a model being downloaded. A value of &quot;subscription_change&quot; indicates the event was triggered by a change to the subscription.</p> </div> <dl class="tsd-comment-tags"> <dt>experimental</dt> <dd></dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="path" class="tsd-anchor"></a> <h3>Path</h3> <div class="tsd-signature tsd-kind-icon">Path<span class="tsd-signature-symbol">:</span> <a href="real_time_data.html#pathelement" class="tsd-signature-type">PathElement</a><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A <code>Path</code> is essentially a set of instructions for retrieving a particular piece of data (subtree) within a model&#39;s contents (JSON tree). e.g.</p> </div> <p>for a model with contents</p> <pre><code class="language-json">{ <span class="hljs-attr">&quot;firstName&quot;</span>: <span class="hljs-string">&quot;James&quot;</span>, <span class="hljs-attr">&quot;kidsAges&quot;</span>: [<span class="hljs-number">4</span>, <span class="hljs-number">7</span>, <span class="hljs-number">9</span>] } </code></pre> <p>one could query:</p> <pre><code class="language-typescript">realTimeModel.elementAt([<span class="hljs-string">&#x27;firstName&#x27;</span>]) <span class="hljs-comment">// RealTimeString, value() =&gt; &quot;James&quot;</span> realTimeModel.elementAt([<span class="hljs-string">&#x27;kidsAges&#x27;</span>, <span class="hljs-number">1</span>]) <span class="hljs-comment">// RealTimeNumber, value() =&gt; 7</span> </code></pre> <p>See the <a href="https://docs.convergence.io/guide/models/overview.html#paths">developer guide</a> for more examples of using paths to get parts of a model&#39;s contents.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="pathelement" class="tsd-anchor"></a> <h3>Path<wbr>Element</h3> <div class="tsd-signature tsd-kind-icon">Path<wbr>Element<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A PathElement is a particular desired node within a <a href="../classes/real_time_data.realtimemodel.html">RealTimeModel</a>&#39;s contents, which can be thought of as a JSON tree.</p> </div> <p>These have no meaning outside of a <a href="real_time_data.html#path">Path</a>.</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="referencetype" class="tsd-anchor"></a> <h3>Reference<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">Reference<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"index"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"range"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"element"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"property"</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A unified type representing any type of reference.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-module"> <a name="modelserviceeventconstants" class="tsd-anchor"></a> <h3>Model<wbr>Service<wbr>Event<wbr>Constants</h3> <div class="tsd-signature tsd-kind-icon">Model<wbr>Service<wbr>Event<wbr>Constants<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_download_completed" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>COMPLETED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>COMPLETED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_download_completed"</span><span class="tsd-signature-symbol"> = &quot;offline_models_download_completed&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_download_pending" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>PENDING</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>PENDING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_download_pending"</span><span class="tsd-signature-symbol"> = &quot;offline_models_download_pending&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_download_progress" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>PROGRESS</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>DOWNLOAD_<wbr>PROGRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_download_progress"</span><span class="tsd-signature-symbol"> = &quot;offline_models_download_progress&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_sync_aborted" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>ABORTED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>ABORTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_sync_aborted"</span><span class="tsd-signature-symbol"> = &quot;offline_models_sync_aborted&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_sync_completed" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>COMPLETED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>COMPLETED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_sync_completed"</span><span class="tsd-signature-symbol"> = &quot;offline_models_sync_completed&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_sync_progress" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>PROGRESS</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>PROGRESS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_sync_progress"</span><span class="tsd-signature-symbol"> = &quot;offline_models_sync_progress&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_models_sync_started" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>STARTED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODELS_<wbr>SYNC_<wbr>STARTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_models_sync_started"</span><span class="tsd-signature-symbol"> = &quot;offline_models_sync_started&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_model_deleted" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODEL_<wbr>DELETED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODEL_<wbr>DELETED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_model_deleted"</span><span class="tsd-signature-symbol"> = &quot;offline_model_deleted&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_model_permissions_revoked" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODEL_<wbr>PERMISSIONS_<wbr>REVOKED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODEL_<wbr>PERMISSIONS_<wbr>REVOKED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_model_permissions_revoked"</span><span class="tsd-signature-symbol"> = &quot;offline_model_permissions_revoked&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_model_status_changed" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODEL_<wbr>STATUS_<wbr>CHANGED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODEL_<wbr>STATUS_<wbr>CHANGED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_model_status_changed"</span><span class="tsd-signature-symbol"> = &quot;offline_model_status_changed&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_model_sync_completed" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODEL_<wbr>SYNC_<wbr>COMPLETED</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODEL_<wbr>SYNC_<wbr>COMPLETED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"offline_model_sync_completed"</span><span class="tsd-signature-symbol"> = &quot;offline_model_sync_completed&quot;</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="modelserviceeventconstants.offline_model_sync_error" class="tsd-anchor"></a> <h3>OFFLINE_<wbr>MODEL_<wbr>SYNC_<wbr>ERROR</h3> <div class="tsd-signature tsd-kind-icon">OFFLINE_<wbr>MODEL_<wbr>SYNC_<wb