Files
parse-community-parse-server/api/master/LiveQueryServerOptions.html

463 lines
22 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>LiveQueryServerOptions - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GridStoreAdapter.html">GridStoreAdapter</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="module-Adapters-WSSAdapter.html">Adapters~WSSAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-WSSAdapter.html#close">close</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-WSSAdapter.html#start">start</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ParseServer.html">ParseServer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ParseServer.html#.app">app</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ParseServer.html#.createLiveQueryServer">createLiveQueryServer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ParseServer.html#.start">start</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ParseServer.html#start">start</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="WSAdapter.html">WSAdapter</a></span></li><li class="nav-heading">Modules</li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-AdapterLoader.html">AdapterLoader</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-AdapterLoader.html#.loadAdapter">loadAdapter</a></span></li><li class="nav-heading"><span class="nav-item-type type-module">M</span><span class="nav-item-name"><a href="module-Adapters.html">Adapters</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-AnalyticsAdapter.html">AnalyticsAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html">CacheAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html">FilesAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-LoggerAdapter.html">LoggerAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-MailAdapter.html">MailAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-PubSubAdapter.html">PubSubAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-PushAdapter.html">PushAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-WSSAdapter.html">WSSAdapter</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Parse.html">Parse</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Parse.Cloud.html">Parse.Cloud</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterDelete">afterDelete</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterDeleteFile">afterDeleteFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterFind">afterFind</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterLiveQueryEvent">afterLiveQueryEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterLogin">afterLogin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterLogout">afterLogout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterSave">afterSave</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.afterSaveFile">afterSaveFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeConnect">beforeConnect</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeDelete">beforeDelete</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeDeleteFile">beforeDeleteFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeFind">beforeFind</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeLogin">beforeLogin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeSave">beforeSave</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeSaveFile">beforeSaveFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.beforeSubscribe">beforeSubscribe</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.httpRequest">httpRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Parse.Cloud.html#.job">job</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.AfterFindRequest.html">AfterFindRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.BeforeFindRequest.html">BeforeFindRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.ConnectTriggerRequest.html">ConnectTriggerRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.FileTriggerRequest.html">FileTriggerRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.FunctionRequest.html">FunctionRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.JobRequest.html">JobRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.LiveQueryEventTrigger.html">LiveQueryEventTrigger</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.TriggerRequest.html">TriggerRequest</a></span></li><li class="nav-item"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="Parse.Cloud.ValidatorObject.html">ValidatorObject</a></span></li><li class="nav-heading">Interfaces</li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="CustomPagesOptions.html">CustomPagesOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="IdempotencyOptions.html">IdempotencyOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="LiveQueryOptions.html">LiveQueryOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="LiveQueryServerOptions.html">LiveQueryServerOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-AnalyticsAdapter.html">Adapters~AnalyticsAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-AnalyticsAdapter.html#appOpened">appOpened</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-AnalyticsAdapter.html#trackEvent">trackEvent</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html">Adapters~CacheAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html#clear">clear</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html#del">del</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html#get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-CacheAdapter.html#put">put</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html">Adapters~FilesAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html#createFile">createFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html#deleteFile">deleteFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html#getFileData">getFileData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-FilesAdapter.html#getFileLocation">getFileLocation</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-LoggerAdapter.html">Adapters~LoggerAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-LoggerAdapter.html#log">log</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-MailAdapter.html">Adapters~MailAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-MailAdapter.html#sendMail">sendMail</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-PubSubAdapter.html">Adapters~PubSubAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-PubSubAdapter.html#.createPublisher">createPublisher</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-PubSubAdapter.html#.createSubscriber">createSubscriber</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="module-Adapters-PushAdapter.html">Adapters~PushAdapter</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-PushAdapter.html#getValidPushTypes">getValidPushTypes</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="module-Adapters-PushAdapter.html#send">send</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="ParseServerOptions.html">ParseServerOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-interface">I</span><span class="nav-item-name"><a href="PubSubAdapter.Publisher.html">PubSubAdapter.Publisher</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#crypto">crypto</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">LiveQueryServerOptions</h1>
<section>
<header>
<h2>
LiveQueryServerOptions
</h2>
</header>
<article>
<div class="container-overview">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>appId</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last"><p>This string should match the appId in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same appId.</p></td>
</tr>
<tr>
<td class="name"><code>cacheTimeout</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="description last"><p>Number in milliseconds. When clients provide the sessionToken to the LiveQuery server, the LiveQuery server will try to fetch its ParseUser's objectId from parse server and store it in the cache. The value defines the duration of the cache. Check the following Security section and our protocol specification for details, defaults to 5 * 1000 ms (5 seconds).</p></td>
</tr>
<tr>
<td class="name"><code>keyPairs</code></td>
<td class="type">
<span class="param-type"><code>Any</code></span>
</td>
<td class="description last"><p>A JSON object that serves as a whitelist of keys. It is used for validating clients when they try to connect to the LiveQuery server. Check the following Security section and our protocol specification for details.</p></td>
</tr>
<tr>
<td class="name"><code>logLevel</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last"><p>This string defines the log level of the LiveQuery server. We support VERBOSE, INFO, ERROR, NONE, defaults to INFO.</p></td>
</tr>
<tr>
<td class="name"><code>masterKey</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last"><p>This string should match the masterKey in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same masterKey.</p></td>
</tr>
<tr>
<td class="name"><code>port</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="description last"><p>The port to run the LiveQuery server, defaults to 1337.</p></td>
</tr>
<tr>
<td class="name"><code>pubSubAdapter</code></td>
<td class="type">
<span class="param-type"><code>Adapter.&lt;<a href="module-Adapters-PubSubAdapter.html">PubSubAdapter</a>></code></span>
</td>
<td class="description last"><p>LiveQuery pubsub adapter</p></td>
</tr>
<tr>
<td class="name"><code>redisOptions</code></td>
<td class="type">
<span class="param-type"><code>Any</code></span>
</td>
<td class="description last"><p>parse-server's LiveQuery redisOptions</p></td>
</tr>
<tr>
<td class="name"><code>redisURL</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last"><p>parse-server's LiveQuery redisURL</p></td>
</tr>
<tr>
<td class="name"><code>serverURL</code></td>
<td class="type">
<span class="param-type"><code>String</code></span>
</td>
<td class="description last"><p>This string should match the serverURL in use by your Parse Server. If you deploy the LiveQuery server alongside Parse Server, the LiveQuery server will try to use the same serverURL.</p></td>
</tr>
<tr>
<td class="name"><code>websocketTimeout</code></td>
<td class="type">
<span class="param-type"><code>Number</code></span>
</td>
<td class="description last"><p>Number of milliseconds between ping/pong frames. The WebSocket server sends ping/pong frames to the clients to keep the WebSocket alive. This value defines the interval of the ping/pong frame from the server to clients, defaults to 10 * 1000 ms (10 s).</p></td>
</tr>
<tr>
<td class="name"><code>wssAdapter</code></td>
<td class="type">
<span class="param-type"><code>Adapter.&lt;<a href="module-Adapters-WSSAdapter.html">WSSAdapter</a>></code></span>
</td>
<td class="description last"><p>Adapter module for the WebSocketServer</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on 2020-11-25T17:42:37.533Z.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>