@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IStorageAdapter | 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/offline.html">Offline</a> </li> <li> <a href="offline.istorageadapter.html">IStorageAdapter</a> </li> </ul> <h1>Interface IStorageAdapter</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">IStorageAdapter</span> </li> </ul> </section> <section class="tsd-panel"> <h3>Implemented by</h3> <ul class="tsd-hierarchy"> <li><a href="../classes/offline.idbstorageadapter.html" class="tsd-signature-type">IdbStorageAdapter</a></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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#adapterid" class="tsd-kind-icon">adapter<wbr>Id</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#destroy" class="tsd-kind-icon">destroy</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#dispose" class="tsd-kind-icon">dispose</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#identitystore" class="tsd-kind-icon">identity<wbr>Store</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#initialize" class="tsd-kind-icon">initialize</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#isdisposed" class="tsd-kind-icon">is<wbr>Disposed</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#isinitialized" class="tsd-kind-icon">is<wbr>Initialized</a></li> <li class="tsd-kind-method tsd-parent-kind-interface"><a href="offline.istorageadapter.html#modelstore" class="tsd-kind-icon">model<wbr>Store</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="adapterid" class="tsd-anchor"></a> <h3>adapter<wbr>Id</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">adapter<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the unique id of this storage adapter. Each adapter class implementation must provide a unique id.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="destroy" class="tsd-anchor"></a> <h3>destroy</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Removes the underlying storage behind this store, deleting all data. The storage adapter will be disposed after calling destroy.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="dispose" class="tsd-anchor"></a> <h3>dispose</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disposes of this storage adapter, releasing any resources. Calls to the storage after calling dispose will likely throw errors.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="identitystore" class="tsd-anchor"></a> <h3>identity<wbr>Store</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">identity<wbr>Store<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="offline.iidentitystore.html" class="tsd-signature-type">IIdentityStore</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the identity store which provides storage for the Identity subsystem.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="offline.iidentitystore.html" class="tsd-signature-type">IIdentityStore</a></h4> <p>The identity store.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="initialize" class="tsd-anchor"></a> <h3>initialize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, domainId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Initializes the offline data store. The storage will be created if it does not exists.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>namespace: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The namespace of the domain being opened.</p> </div> </li> <li> <h5>domainId: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The id of the domain being opened.</p> </div> </li> <li> <h5>username: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The user name of the user opening the store.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="isdisposed" class="tsd-anchor"></a> <h3>is<wbr>Disposed</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">is<wbr>Disposed<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines if the storage is disposed.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>true if the storage is disposed, false otherwise.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="isinitialized" class="tsd-anchor"></a> <h3>is<wbr>Initialized</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">is<wbr>Initialized<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines if the storage is initialized.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>true if the storage is initialized, false otherwise.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <a name="modelstore" class="tsd-anchor"></a> <h3>model<wbr>Store</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <li class="tsd-signature tsd-kind-icon">model<wbr>Store<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="offline.imodelstore.html" class="tsd-signature-type">IModelStore</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the model store which provides storage for the Real Time Model subsystem.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="offline.imodelstore.html" class="tsd-signature-type">IModelStore</a></h4> <p>The model store.</p> </li> </ul> </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="current 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=" 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"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/offline.idbstorageadapter.html" class="tsd-kind-icon">Idb<wbr>Storage<wbr>Adapter</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.idomainuseriddata.html" class="tsd-kind-icon">IDomain<wbr>User<wbr>IdData</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.iidentitystore.html" class="tsd-kind-icon">IIdentity<wbr>Store</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.ilocaloperationdata.html" class="tsd-kind-icon">ILocal<wbr>Operation<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelcreationdata.html" class="tsd-kind-icon">IModel<wbr>Creation<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodeldata.html" class="tsd-kind-icon">IModel<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodeldataupdate.html" class="tsd-kind-icon">IModel<wbr>Data<wbr>Update</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelmetadata.html" class="tsd-kind-icon">IModel<wbr>Meta<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelmetadatadocument.html" class="tsd-kind-icon">IModel<wbr>Meta<wbr>Data<wbr>Document</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodeloperationdata.html" class="tsd-kind-icon">IModel<wbr>Operation<wbr>Data</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelsnapshot.html" class="tsd-kind-icon">IModel<wbr>Snapshot</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelstate.html" class="tsd-kind-icon">IModel<wbr>State</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelstore.html" class="tsd-kind-icon">IModel<wbr>Store</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.imodelupdate.html" class="tsd-kind-icon">IModel<wbr>Update</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="offline.iserveroperationdata.html" class="tsd-kind-icon">IServer<wbr>Operation<wbr>Data</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> <a href="offline.istorageadapter.html" class="tsd-kind-icon">IStorage<wbr>Adapter</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#adapterid" class="tsd-kind-icon">adapter<wbr>Id</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#destroy" class="tsd-kind-icon">destroy</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#dispose" class="tsd-kind-icon">dispose</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#identitystore" class="tsd-kind-icon">identity<wbr>Store</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#initialize" class="tsd-kind-icon">initialize</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#isdisposed" class="tsd-kind-icon">is<wbr>Disposed</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#isinitialized" class="tsd-kind-icon">is<wbr>Initialized</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface"> <a href="offline.istorageadapter.html#modelstore" class="tsd-kind-icon">model<wbr>Store</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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>