@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ICreateModelOptions | 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.icreatemodeloptions.html">ICreateModelOptions</a> </li> </ul> <h1>Interface ICreateModelOptions</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>The configuration available when creating a model with the <a href="../classes/real_time_data.modelservice.html#create">ModelService.create</a> or <a href="../classes/real_time_data.modelservice.html#openautocreate">ModelService.openAutoCreate</a> methods.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ICreateModelOptions</span> <ul class="tsd-hierarchy"> <li> <a href="real_time_data.iautocreatemodeloptions.html" class="tsd-signature-type">IAutoCreateModelOptions</a> </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 "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#collection" class="tsd-kind-icon">collection</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#data" class="tsd-kind-icon">data</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#overridecollectionworldpermissions" class="tsd-kind-icon">override<wbr>Collection<wbr>World<wbr>Permissions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#userpermissions" class="tsd-kind-icon">user<wbr>Permissions</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="real_time_data.icreatemodeloptions.html#worldpermissions" class="tsd-kind-icon">world<wbr>Permissions</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="collection" class="tsd-anchor"></a> <h3>collection</h3> <div class="tsd-signature tsd-kind-icon">collection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The collection in which this model will live.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="data" class="tsd-anchor"></a> <h3>data</h3> <div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../modules/real_time_data.html#modeldatainitializer" class="tsd-signature-type">ModelDataInitializer</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The initial contents of the model, either provided directly or as the result of a callback function. This data should be easily serializable.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="id" class="tsd-anchor"></a> <h3>id</h3> <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The model's ID. If not provided, a UUID will be generated.</p> </div> <p>Note that model IDs must be unique <em>even across collections</em>!</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="overridecollectionworldpermissions" class="tsd-anchor"></a> <h3>override<wbr>Collection<wbr>World<wbr>Permissions</h3> <div class="tsd-signature tsd-kind-icon">override<wbr>Collection<wbr>World<wbr>Permissions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set to true if the permissions set in this object should override those set in the parent collection.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="userpermissions" class="tsd-anchor"></a> <h3>user<wbr>Permissions</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Permissions<span class="tsd-signature-symbol">:</span> <a href="../modules/users_and_identity.html#domainusermapping" class="tsd-signature-type">DomainUserMapping</a><span class="tsd-signature-symbol"><</span><a href="real_time_data.imodelpermissions.html" class="tsd-signature-type">IModelPermissions</a><span class="tsd-signature-symbol">></span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Per-user permissions can be set here, where the key is an existing user's username.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="worldpermissions" class="tsd-anchor"></a> <h3>world<wbr>Permissions</h3> <div class="tsd-signature tsd-kind-icon">world<wbr>Permissions<span class="tsd-signature-symbol">:</span> <a href="real_time_data.imodelpermissions.html" class="tsd-signature-type">IModelPermissions</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Generic permissions for this model for all users.</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.icreatemodeloptions.html" class="tsd-kind-icon">ICreate<wbr>Model<wbr>Options</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#collection" class="tsd-kind-icon">collection</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#data" class="tsd-kind-icon">data</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#id" class="tsd-kind-icon">id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#overridecollectionworldpermissions" class="tsd-kind-icon">override<wbr>Collection<wbr>World<wbr>Permissions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#userpermissions" class="tsd-kind-icon">user<wbr>Permissions</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="real_time_data.icreatemodeloptions.html#worldpermissions" class="tsd-kind-icon">world<wbr>Permissions</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>