Skip to content

Commit

Permalink
v8.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@weswit-team
weswit-team committed Dec 11, 2019
1 parent 477cf7d commit b54b47e
Show file tree
Hide file tree
Showing 20 changed files with 361 additions and 264 deletions.
7 changes: 4 additions & 3 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,17 @@
},
"devDependencies": {
"@ampproject/rollup-plugin-closure-compiler": "^0.9.0",
"jsdoc": "3.5.5",
"tsd-jsdoc": "^2.3.1",
"jsdoc": "^3.6.3",
"magic-string": "^0.25.3",
"minimist": "^1.2.0",
"requirejs": "^2.3.6",
"rollup": "^1.16.6",
"rollup-plugin-alias": "^1.5.2",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-replace": "^2.2.0",
"rollup-plugin-virtual": "^1.0.1"
"rollup-plugin-virtual": "^1.0.1",
"taffydb": "^2.7.3",
"tsd-jsdoc": "^2.3.1"
},
"scripts": {
"build": "node tools/build --config tools/build.config.js"
Expand Down
43 changes: 22 additions & 21 deletions source/LightstreamerClient.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1088,11 +1088,11 @@ END_NODE_JSDOC_EXCLUDE
* Operation method that registers the MPN device on the server's MPN Module.<BR>
* By registering an MPN device, the client enables MPN functionalities such as {@link LightstreamerClient#subscribeMpn}.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @lifecycle An {@link MpnDevice} can be registered at any time. The registration will be notified through a {@link MpnDeviceListener#onRegistered} event.
* <p class="lifecycle"><b>Lifecycle:</b> An {@link MpnDevice} can be registered at any time. The registration will be notified through a {@link MpnDeviceListener#onRegistered} event.</p>
*
* @param device An {@link MpnDevice} instance, carrying all the information about the MPN device.
* @throws IllegalArgumentException if the specified device is null.
Expand Down Expand Up @@ -1126,15 +1126,15 @@ END_NODE_JSDOC_EXCLUDE
* the same subscriptions have been activated before or not. In fact, since MPN subscriptions are persistent, if they are activated every time the app starts and
* the <code>coalescing</code> flag is not set, every activation is a <i>new</i> MPN subscription, leading to multiple push notifications for the same event.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @lifecycle An MpnSubscription can be given to the LightstreamerClient once an MpnDevice registration has been requested. The MpnSubscription
* <p class="lifecycle"><b>Lifecycle:</b> An MpnSubscription can be given to the LightstreamerClient once an MpnDevice registration has been requested. The MpnSubscription
* immediately enters the "active" state.<BR>
* Once "active", an MpnSubscription instance cannot be provided again to an LightstreamerClient unless it is first removed from the "active" state through
* a call to {@link #unsubscribeMpn}.<BR>
* A successful subscription to the server will be notified through an {@link MpnSubscriptionListener#onSubscription} event.
* A successful subscription to the server will be notified through an {@link MpnSubscriptionListener#onSubscription} event.</p>
*
* @param subscription An MpnSubscription object, carrying all the information to route real-time data via push notifications.
* @param coalescing A flag that specifies if the MPN subscription must coalesce with any pre-existing MPN subscription with the same Adapter Set, Data Adapter,
Expand Down Expand Up @@ -1177,12 +1177,12 @@ END_NODE_JSDOC_EXCLUDE
* Operation method that unsubscribes an MpnSubscription from the server's MPN Module.<BR>
* This operation removes the MpnSubscription from the list of "active" subscriptions.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @lifecycle An MpnSubscription can be unsubscribed from at any time. Once done the MpnSubscription immediately exits the "active" state.<BR>
* The unsubscription will be notified through an {@link MpnSubscriptionListener#onUnsubscription} event.
* <p class="lifecycle"><b>Lifecycle:</b> An MpnSubscription can be unsubscribed from at any time. Once done the MpnSubscription immediately exits the "active" state.<BR>
* The unsubscription will be notified through an {@link MpnSubscriptionListener#onUnsubscription} event.</p>
*
* @param subscription An "active" MpnSubscription object.
* @throws IllegalStateException if the given MPN subscription is not active.
Expand All @@ -1208,12 +1208,12 @@ END_NODE_JSDOC_EXCLUDE
* By specifying a status filter it is possible to unsubscribe multiple MPN subscriptions at once. E.g. by passing <code>TRIGGERED</code> it is possible
* to unsubscribe all triggered MPN subscriptions. This operation removes the involved MPN subscriptions from the list of "active" subscriptions.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @lifecycle Multiple unsubscription can be requested at any time. Once done the involved MPN subscriptions immediately exit the "active" state.<BR>
* The unsubscription will be notified through an {@link MpnSubscriptionListener#onUnsubscription} event to all involved MPN subscriptions.
* <p class="lifecycle"><b>Lifecycle:</b> Multiple unsubscription can be requested at any time. Once done the involved MPN subscriptions immediately exit the "active" state.<BR>
* The unsubscription will be notified through an {@link MpnSubscriptionListener#onUnsubscription} event to all involved MPN subscriptions.</p>
*
* @param filter A status name to be used to select the MPN subscriptions to unsubscribe. If null all existing MPN subscriptions
* are unsubscribed. Possible filter values are:<ul>
Expand Down Expand Up @@ -1246,12 +1246,12 @@ END_NODE_JSDOC_EXCLUDE
* {@link MpnSubscription#getSubscriptionId} value to verify the equivalence of two MpnSubscription objects. Substitutions may happen
* when an MPN subscription is modified, or when it is coalesced with a pre-existing subscription.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @lifecycle The collection is available once an MpnDevice registration has been requested, but reflects the actual server's collection only
* after an {@link MpnDeviceListener#onSubscriptionsUpdated} event has been notified.
* <p class="lifecycle"><b>Lifecycle:</b> The collection is available once an MpnDevice registration has been requested, but reflects the actual server's collection only
* after an {@link MpnDeviceListener#onSubscriptionsUpdated} event has been notified.</p>
*
* @param {String} filter An MPN subscription status name to be used to select the MPN subscriptions to return. If null all existing MPN subscriptions
* are returned. Possible filter values are:<ul>
Expand Down Expand Up @@ -1286,9 +1286,9 @@ END_NODE_JSDOC_EXCLUDE
* {@link MpnSubscription#getSubscriptionId} value to verify the equivalence of two MpnSubscription objects. Substitutions may happen
* when an MPN subscription is modified, or when it is coalesced with a pre-existing subscription.
*
* @general_edition_note MPN is an optional feature, available depending on Edition and License Type.
* <p class="edition-note"><B>Edition Note:</B> MPN is an optional feature, available depending on Edition and License Type.
* To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default,
* available at /dashboard).
* available at /dashboard).</p>
*
* @param {String} subscriptionId The subscription ID to search for.
* @return {MpnSubscription} the MpnSubscription with the specified ID, or null if not found.
Expand Down Expand Up @@ -1341,6 +1341,7 @@ END_NODE_JSDOC_EXCLUDE
* Enable WS if disabled.
*/
LightstreamerClient["__restoreWs"] = WebSocketConnection.restoreClass;
LightstreamerClient["__disableWs"] = WebSocketConnection.disableClass;

/*
* TEST-ONLY METHOD.
Expand Down
18 changes: 9 additions & 9 deletions source/MpnDevice.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ export default /*@__PURE__*/(function() {
/**
* The platform identifier of this MPN device. It equals <code>Google</code> or <code>Apple</code> and is used by the server as part of the device identification.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the MPN device platform.
*/
Expand All @@ -123,7 +123,7 @@ export default /*@__PURE__*/(function() {
/**
* The application ID of this MPN device. It is used by the server as part of the device identification.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the MPN device application ID.
*/
Expand All @@ -135,7 +135,7 @@ export default /*@__PURE__*/(function() {
* The device token of this MPN device. It is passed during creation and
* is used by the server as part of the device identification.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the MPN device token.
*/
Expand All @@ -148,7 +148,7 @@ export default /*@__PURE__*/(function() {
* localStorage during creation and is used by the server to restore MPN subscriptions associated with this previous token. May be null if
* no MPN device has been registered yet on the application.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the previous MPN device token, or null if no MPN device has been registered yet.
*/
Expand All @@ -160,7 +160,7 @@ export default /*@__PURE__*/(function() {
* Checks whether the MPN device object is currently registered on the server or not.<BR>
* This flag is switched to true by server sent registration events, and back to false in case of client disconnection or server sent suspension events.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {boolean} true if the MPN device object is currently registered on the server.
*
Expand All @@ -175,7 +175,7 @@ export default /*@__PURE__*/(function() {
* An MPN device may be suspended if errors occur during push notification delivery.<BR>
* This flag is switched to true by server sent suspension events, and back to false in case of client disconnection or server sent resume events.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {boolean} true if the MPN device object is currently suspended on the server.
*
Expand All @@ -195,7 +195,7 @@ export default /*@__PURE__*/(function() {
* {@link MpnDevice#isRegistered} and {@link MpnDevice#isSuspended} are both true.</li>
* </ul>
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the status of the device.
*
Expand All @@ -209,7 +209,7 @@ export default /*@__PURE__*/(function() {
/**
* The server-side timestamp of the device status.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {Number} The server-side timestamp of the device status.
*
Expand All @@ -226,7 +226,7 @@ export default /*@__PURE__*/(function() {
* Note: a device token change, if the previous device token was correctly stored on localStorage, does not cause the device ID to change: the
* server moves previous MPN subscriptions from the previous token to the new one and the device ID remains unaltered.
*
* @lifecycle This method can be called at any time.
* <p class="lifecycle"><b>Lifecycle:</b> This method can be called at any time.</p>
*
* @return {String} the MPN device ID.
*/
Expand Down
Loading

0 comments on commit b54b47e

Please sign in to comment.