/** * Copyright (c) 2015-present, Parse, LLC. * All rights reserved. * * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. An additional grant * of patent rights can be found in the PATENTS file in the same directory. * * @flow */ import EventEmitter from './EventEmitter'; import LiveQueryClient from './LiveQueryClient'; import CoreManager from './CoreManager'; function getLiveQueryClient() /*: LiveQueryClient*/ { return CoreManager.getLiveQueryController().getDefaultLiveQueryClient(); } /** * * We expose three events to help you monitor the status of the WebSocket connection: * *
Open - When we establish the WebSocket connection to the LiveQuery server, you'll get this event. * *
* Parse.LiveQuery.on('open', () => { * * });* *
Close - When we lose the WebSocket connection to the LiveQuery server, you'll get this event. * *
* Parse.LiveQuery.on('close', () => { * * });* *
Error - When some network error or LiveQuery server error happens, you'll get this event. * *
* Parse.LiveQuery.on('error', (error) => { * * });* * @class Parse.LiveQuery * @static * */ const LiveQuery = new EventEmitter(); /** * After open is called, the LiveQuery will try to send a connect request * to the LiveQuery server. */ LiveQuery.open = async () => { const liveQueryClient = await getLiveQueryClient(); return liveQueryClient.open(); }; /** * When you're done using LiveQuery, you can call Parse.LiveQuery.close(). * This function will close the WebSocket connection to the LiveQuery server, * cancel the auto reconnect, and unsubscribe all subscriptions based on it. * If you call query.subscribe() after this, we'll create a new WebSocket * connection to the LiveQuery server. */ LiveQuery.close = async () => { const liveQueryClient = await getLiveQueryClient(); return liveQueryClient.close(); }; // Register a default onError callback to make sure we do not crash on error LiveQuery.on('error', () => {}); export default LiveQuery; let defaultLiveQueryClient; const DefaultLiveQueryController = { setDefaultLiveQueryClient(liveQueryClient /*: LiveQueryClient*/ ) { defaultLiveQueryClient = liveQueryClient; }, async getDefaultLiveQueryClient() /*: Promise