@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IConvergenceOptions | 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/connection_and_authentication.html">Connection and Authentication</a> </li> <li> <a href="connection_and_authentication.iconvergenceoptions.html">IConvergenceOptions</a> </li> </ul> <h1>Interface IConvergenceOptions</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 <a href="connection_and_authentication.iconvergenceoptions.html">IConvergenceOptions</a> interface represents that options that can be set within Convergence when connecting to a domain.</p> </div> <p>See the <a href="https://github.com/convergencelabs/convergence-client-javascript/blob/master/src/main/ConvergenceOptions.ts">ConvergenceOptions</a> implementation for the default settings.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IConvergenceOptions</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#connection" class="tsd-kind-icon">connection</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#models" class="tsd-kind-icon">models</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#offline" class="tsd-kind-icon">offline</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#protocol" class="tsd-kind-icon">protocol</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#reconnect" class="tsd-kind-icon">reconnect</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="connection_and_authentication.iconvergenceoptions.html#websocket" class="tsd-kind-icon">web<wbr>Socket</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="connection" class="tsd-anchor"></a> <h3>connection</h3> <div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>connectionRequestTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Options that configure the connection strategy.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>connection<wbr>Request<wbr>Timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The maximum time in seconds to wait for a successful connection request to be completed. The default value is 10 seconds.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The maximum time in seconds to wait for a successful web socket connection to be made. The default value is 5 seconds.</p> </div> </div> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="models" class="tsd-anchor"></a> <h3>models</h3> <div class="tsd-signature tsd-kind-icon">models<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>undefinedArrayValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"null"</span><span class="tsd-signature-symbol">; </span>undefinedObjectValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configures the model subsystem.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>undefinedArrayValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"null"</span><span class="tsd-signature-symbol">; </span>undefinedObjectValues<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configure how data is handled within models.</p> </div> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>undefined<wbr>Array<wbr>Values<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"null"</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines what happens when data is supplied that contains an array that contains <strong>undefined</strong> at one or more indices. If set to <strong>"error"</strong> (the default) the client will throw an error if if it detects an undefined value within an array. If set to "null", the value will be converted to <strong>null</strong>.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>undefined<wbr>Object<wbr>Values<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"error"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"omit"</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines what happens when data is supplied to an object that contains a property with a value of undefined. If set to <strong>"error"</strong> (the default) the client will throw an error if if it detects an undefined value in an object. If set to "omit", the property will simply be omitted from the resultant RealTimeObject.</p> </div> </div> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="offline" class="tsd-anchor"></a> <h3>offline</h3> <div class="tsd-signature tsd-kind-icon">offline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>modelSnapshotInterval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>storage<span class="tsd-signature-symbol">: </span><a href="offline.istorageadapter.html" class="tsd-signature-type">IStorageAdapter</a><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configures offline storage for Convergence. Several of these options are required to enable offline editing of data.</p> </div> <dl class="tsd-comment-tags"> <dt>experimental</dt> <dd></dd> </dl> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>model<wbr>Snapshot<wbr>Interval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The number of operations after which a snapshot of local offline that is being edited should be taken. The default is 100.</p> </div> <dl class="tsd-comment-tags"> <dt>experimental</dt> <dd></dd> </dl> </div> </li> <li class="tsd-parameter"> <h5>storage<span class="tsd-signature-symbol">: </span><a href="offline.istorageadapter.html" class="tsd-signature-type">IStorageAdapter</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The storage adapter to use for offline storage.</p> </div> <dl class="tsd-comment-tags"> <dt>experimental</dt> <dd></dd> </dl> </div> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="protocol" class="tsd-anchor"></a> <h3>protocol</h3> <div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>defaultRequestTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>heartbeat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>pingInterval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pongTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configures the behavior of the messaging protocol subsystem.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>default<wbr>Request<wbr>Timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The timeout for a request to the server, in seconds. The default value is 10 seconds.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>heartbeat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>pingInterval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>pongTimeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configures the keep-alive heartbeat.</p> </div> </div> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>enabled<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines if the heartbeat is enabled.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>ping<wbr>Interval<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Configures how long the client will wait, in seconds after the last message is received from the server before a ping will be sent. The default value is 5 seconds.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>pong<wbr>Timeout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Specifies the time in seconds the client will wait for a response from the server to a ping before considering the connection dead. The default value is 10 seconds.</p> </div> </div> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="reconnect" class="tsd-anchor"></a> <h3>reconnect</h3> <div class="tsd-signature tsd-kind-icon">reconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>autoReconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>autoReconnectOnInitial<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>fallbackAuth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>authChallenge<span class="tsd-signature-symbol">: </span><a href="connection_and_authentication.ifallbackauthchallenge.html" class="tsd-signature-type">IFallbackAuthChallenge</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>reconnectIntervals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Options that configure how Convergence will reconnect when an established connection is lost unexpectedly or when the intial connection fails.</p> </div> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>auto<wbr>Reconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to automatically reconnect when the connection is unexpectedly dropped. Note this setting only applies to connections that have succeeded and then were lost. This setting does not apply to the initial connection, or the first connection made after disconnect is called on the domain. Default is true.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>auto<wbr>Reconnect<wbr>OnInitial<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to automatically reconnect if the initial connection fails. Setting this to false will prevent Convergence from reconnecting automatically if the initial connection (as requested by directly calling one of the connect methods), but will still allow Convergence to reconnect if it was disconnected unintentionally after the first connection was made. Note that if a connection is successful, and then disconnect is called, the subsequent call to connect will be treated as an initial connection. Default is true.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>fallback<wbr>Auth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>authChallenge<span class="tsd-signature-symbol">: </span><a href="connection_and_authentication.ifallbackauthchallenge.html" class="tsd-signature-type">IFallbackAuthChallenge</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The fallbackAuth method to use when a reconnect token is rejected. It provides the opportunity to use a fallback method of authentication.</p> </div> <pre><code>options.reconnect.fallbackAuth = <span class="hljs-function">(<span class="hljs-params">authChallenge:IFallbackAuthChallenge</span>) =></span> { <span class="hljs-keyword">return</span> YourAuthenticationService.getNewJwt().then(<span class="hljs-function"><span class="hljs-params">jwt</span> =></span> { authChallenge.jwt(jwt); }) }; </code></pre> </div> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>authChallenge<span class="tsd-signature-symbol">: </span><a href="connection_and_authentication.ifallbackauthchallenge.html" class="tsd-signature-type">IFallbackAuthChallenge</a><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"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>authChallenge: <a href="connection_and_authentication.ifallbackauthchallenge.html" class="tsd-signature-type">IFallbackAuthChallenge</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> <li class="tsd-parameter"> <h5>reconnect<wbr>Intervals<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The intervals to use between reconnects. This array will be sorted from smallest to largest. When the largest interval is reached it will simply be repeated.</p> </div> </div> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="websocket" class="tsd-anchor"></a> <h3>web<wbr>Socket</h3> <div class="tsd-signature tsd-kind-icon">web<wbr>Socket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>class<span class="tsd-signature-symbol">?: </span><a href="connection_and_authentication.iwebsocketclass.html" class="tsd-signature-type">IWebSocketClass</a><span class="tsd-signature-symbol">; </span>factory<span class="tsd-signature-symbol">?: </span><a href="../modules/connection_and_authentication.html#websocketfactory" class="tsd-signature-type">WebSocketFactory</a><span class="tsd-signature-symbol"> }</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Options that configure how Convergence will use WebSockets.</p> </div> <p>See the Node.js Usage section on [this page] for an example of these parameters in action.</p> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>class<span class="tsd-signature-symbol">?: </span><a href="connection_and_authentication.iwebsocketclass.html" class="tsd-signature-type">IWebSocketClass</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The constructor to use when creating a web socket. Essentially this is class that should be used to represent the web socket.</p> </div> </div> </li> <li class="tsd-parameter"> <h5>factory<span class="tsd-signature-symbol">?: </span><a href="../modules/connection_and_authentication.html#websocketfactory" class="tsd-signature-type">WebSocketFactory</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Defines the class / constructor that should be used to create WebSocket objects. This is useful when operating in NodeJS where a library like ws or isomorphic-ws can be used to provide a client side WebSocket API.</p> </div> </div> </li> </ul> </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="current 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=" 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-enum tsd-parent-kind-module"> <a href="../enums/connection_and_authentication.authenticationmethods.html" class="tsd-kind-icon">Authentication<wbr>Methods</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.authenticatingevent.html" class="tsd-kind-icon">Authenticating<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.cancellationtoken.html" class="tsd-kind-icon">Cancellation<wbr>Token</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.connectedevent.html" class="tsd-kind-icon">Connected<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.connectingevent.html" class="tsd-kind-icon">Connecting<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.connectionfailedevent.html" class="tsd-kind-icon">Connection<wbr>Failed<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.connectionscheduledevent.html" class="tsd-kind-icon">Connection<wbr>Scheduled<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.disconnectedevent.html" class="tsd-kind-icon">Disconnected<wbr>Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/connection_and_authentication.interruptedevent.html" class="tsd-kind-icon">Interrupted<wbr>Event</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="connection_and_authentication.iconvergencedomainevent.html" class="tsd-kind-icon">IConvergence<wbr>Domain<wbr>Event</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> <a href="connection_and_authentication.iconvergenceoptions.html" class="tsd-kind-icon">IConvergence<wbr>Options</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#connection" class="tsd-kind-icon">connection</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#models" class="tsd-kind-icon">models</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#offline" class="tsd-kind-icon">offline</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#protocol" class="tsd-kind-icon">protocol</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#reconnect" class="tsd-kind-icon">reconnect</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="connection_and_authentication.iconvergenceoptions.html#websocket" class="tsd-kind-icon">web<wbr>Socket</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="connection_and_authentication.ifallbackauthchallenge.html" class="tsd-kind-icon">IFallback<wbr>Auth<wbr>Challenge</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="connection_and_authentication.iusernameandpassword.html" class="tsd-kind-icon">IUsername<wbr>And<wbr>Password</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="connection_and_authentication.iwebsocketclass.html" class="tsd-kind-icon">IWeb<wbr>Socket<wbr>Class</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#authenticationmethod" class="tsd-kind-icon">Authentication<wbr>Method</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#websocketfactory" class="tsd-kind-icon">Web<wbr>Socket<wbr>Factory</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#configurelogging" class="tsd-kind-icon">configure<wbr>Logging</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#connect" class="tsd-kind-icon">connect</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#connectanonymously" class="tsd-kind-icon">connect<wbr>Anonymously</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#connectwithjwt" class="tsd-kind-icon">connect<wbr>With<wbr>Jwt</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#connectwithpassword" class="tsd-kind-icon">connect<wbr>With<wbr>Password</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/connection_and_authentication.html#reconnect" class="tsd-kind-icon">reconnect</a> </li> </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>