/* * 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. * */ import EventEmitter from './EventEmitter'; import CoreManager from './CoreManager'; /** * Creates a new LiveQuery Subscription. * Extends events.EventEmitter * cloud functions. * * *
Open Event - When you call query.subscribe(), we send a subscribe request to * the LiveQuery server, when we get the confirmation from the LiveQuery server, * this event will be emitted. When the client loses WebSocket connection to the * LiveQuery server, we will try to auto reconnect the LiveQuery server. If we * reconnect the LiveQuery server and successfully resubscribe the ParseQuery, * you'll also get this event. * *
* subscription.on('open', () => { * * });* *
Create Event - When a new ParseObject is created and it fulfills the ParseQuery you subscribe, * you'll get this event. The object is the ParseObject which is created. * *
* subscription.on('create', (object) => { * * });* *
Update Event - When an existing ParseObject (original) which fulfills the ParseQuery you subscribe * is updated (The ParseObject fulfills the ParseQuery before and after changes), * you'll get this event. The object is the ParseObject which is updated. * Its content is the latest value of the ParseObject. * * Parse-Server 3.1.3+ Required for original object parameter * *
* subscription.on('update', (object, original) => { * * });* *
Enter Event - When an existing ParseObject's (original) old value doesn't fulfill the ParseQuery * but its new value fulfills the ParseQuery, you'll get this event. The object is the * ParseObject which enters the ParseQuery. Its content is the latest value of the ParseObject. * * Parse-Server 3.1.3+ Required for original object parameter * *
* subscription.on('enter', (object, original) => { * * });* * *
Update Event - When an existing ParseObject's old value fulfills the ParseQuery but its new value * doesn't fulfill the ParseQuery, you'll get this event. The object is the ParseObject * which leaves the ParseQuery. Its content is the latest value of the ParseObject. * *
* subscription.on('leave', (object) => { * * });* * *
Delete Event - When an existing ParseObject which fulfills the ParseQuery is deleted, you'll * get this event. The object is the ParseObject which is deleted. * *
* subscription.on('delete', (object) => { * * });* * *
Close Event - When the client loses the WebSocket connection to the LiveQuery * server and we stop receiving events, you'll get this event. * *
* subscription.on('close', () => { * * });* * @alias Parse.LiveQuerySubscription */ class Subscription extends EventEmitter { /* * @param {string} id - subscription id * @param {string} query - query to subscribe to * @param {string} sessionToken - optional session token */ constructor(id, query, sessionToken) { super(); this.id = id; this.query = query; this.sessionToken = sessionToken; // adding listener so process does not crash // best practice is for developer to register their own listener this.on('error', () => {}); } /** * Close the subscription */ unsubscribe() /*: Promise*/ { return CoreManager.getLiveQueryController().getDefaultLiveQueryClient().then(liveQueryClient => { liveQueryClient.unsubscribe(this); this.emit('close'); }); } } export default Subscription;