diffusion
Advanced tools
Comparing version 6.5.1 to 6.5.2
{ | ||
"name": "diffusion", | ||
"version": "6.5.1", | ||
"version": "6.5.2", | ||
"description": "Diffusion JavaScript client", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
148
README.md
@@ -8,3 +8,3 @@ ## Diffusion JavaScript API | ||
adding, removing or updating topics. For a full list of capabilities in the JavaScript API, see the | ||
[Contents](https://download.pushtechnology.com/docs/6.5.1/js/index.html#section-contents) section | ||
[Contents](https://download.pushtechnology.com/docs/6.5.2/js/index.html#section-contents) section | ||
below. | ||
@@ -41,6 +41,6 @@ | ||
[`version: string;`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#version)<br> | ||
[`version: string;`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#version)<br> | ||
The version of this client library in the form major.minor.patch | ||
[`build: string`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#build)<br> | ||
[`build: string`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#build)<br> | ||
The build version of this client library | ||
@@ -50,24 +50,24 @@ | ||
[`function log(level: LogLevel | keyof typeof LogLevel)`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#log)<br> | ||
[`function log(level: LogLevel | keyof typeof LogLevel)`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#log)<br> | ||
Set the level of logging used by Diffusion. | ||
[`function connect(options: Options): Result<Session>`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#connect)<br> | ||
[`function connect(options: Options): Result<Session>`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#connect)<br> | ||
Connect to a specified Diffusion server. | ||
[`function escape(s: string)`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#escape)<br> | ||
[`function escape(s: string)`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#escape)<br> | ||
Escapes special characters in a string that is to be used within a topic | ||
property or a session filter. | ||
[`function stringToRoles(s: string)`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#stringtoroles)<br> | ||
[`function stringToRoles(s: string)`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#stringtoroles)<br> | ||
Utility method which converts a string of the format required by the | ||
[$Roles](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/propertykeys.html#roles) | ||
[$Roles](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/propertykeys.html#roles) | ||
session property into a mutable set of strings. | ||
[`rolesToString(roles: Set<string> | string[])`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#rolestostring)<br> | ||
[`rolesToString(roles: Set<string> | string[])`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#rolestostring)<br> | ||
Utility method which converts a set of authorization roles to the string format required by the | ||
[$Roles](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/propertykeys.html#roles) | ||
[$Roles](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/propertykeys.html#roles) | ||
session property. | ||
[`function updateConstraints(): UpdateConstraintFactory`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#updateconstraints)<br> | ||
[`function updateConstraints(): UpdateConstraintFactory`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#updateconstraints)<br> | ||
Returns an update constraint factory. | ||
@@ -77,23 +77,23 @@ | ||
[`const datatypes`](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/datatypes.html)<br> | ||
[`const datatypes`](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/datatypes.html)<br> | ||
Access to the *datatypes* namespace | ||
[`const locks`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#sessionlockoptions)<br> | ||
[`const locks`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#sessionlockoptions)<br> | ||
Access to the *locks* namespace | ||
[`const selectors `](https://download.pushtechnology.com/docs/6.5.1/js/classes/topicselectors.html)<br> | ||
[`const selectors `](https://download.pushtechnology.com/docs/6.5.2/js/classes/topicselectors.html)<br> | ||
Access to the *selectors* namespace | ||
[`const topics`](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicsnamespace.html)<br> | ||
[`const topics`](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicsnamespace.html)<br> | ||
Access to the *topics* namespace | ||
[`const topicUpdate`](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicupdatenamespace.html)<br> | ||
[`const topicUpdate`](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicupdatenamespace.html)<br> | ||
Access to the *topicUpdate* namespace | ||
[`const errors`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#errorreason)<br> | ||
The [ErrorReason](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#errorreason) enum | ||
[`const errors`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#errorreason)<br> | ||
The [ErrorReason](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#errorreason) enum | ||
[`const clients`](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#clientcontroloptions)<br> | ||
[`const clients`](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#clientcontroloptions)<br> | ||
Access to | ||
[PropertyKeys](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#clientcontroloptions.propertykeys) | ||
[PropertyKeys](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#clientcontroloptions.propertykeys) | ||
and other client control options | ||
@@ -103,3 +103,3 @@ | ||
A client [Session](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html) | ||
A client [Session](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html) | ||
maintains a connection to the server. To create a session, simply do | ||
@@ -112,4 +112,4 @@ | ||
It is also possible to | ||
[connect](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#connect) with a map of | ||
[options](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/options.html) | ||
[connect](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#connect) with a map of | ||
[options](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/options.html) | ||
@@ -138,4 +138,4 @@ ```javascript | ||
Sessions emit events to indicate their status such as when they are | ||
[disconnected](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#event-disconnect) | ||
or [closed](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#event-close). | ||
[disconnected](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#event-disconnect) | ||
or [closed](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#event-close). | ||
These events are easy to listen to: | ||
@@ -161,6 +161,6 @@ | ||
through a [topic | ||
selector](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicselector.html). | ||
selector](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicselector.html). | ||
The way that a session receives data is by | ||
[subscribing](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#select). | ||
[subscribing](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#select). | ||
Subscriptions allow the session to select one or more topics to receive values from. A session may subscribe to many | ||
@@ -174,5 +174,5 @@ topics, as well as subscribe to the same topic multiple times. | ||
To attach listeners for received values, a | ||
[ValueStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/valuestream.html) is used. | ||
[ValueStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/valuestream.html) is used. | ||
The stream that is returned will emit | ||
[value](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/valuestream.html#event-value) | ||
[value](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/valuestream.html#event-value) | ||
events when the value of the selected topic changes. | ||
@@ -196,12 +196,12 @@ | ||
* Connect the JavaScript client to Diffusion or Diffusion Cloud by using the | ||
[diffusion.connect](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#connect) method. | ||
[diffusion.connect](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#connect) method. | ||
* To change the security principal that the client is connected with, use the | ||
[changePrincipal](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#changeprincipal) method. | ||
[changePrincipal](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#changeprincipal) method. | ||
* The client can log out information by using the | ||
[diffusion.log](https://download.pushtechnology.com/docs/6.5.1/js/globals.html#log) method. | ||
[diffusion.log](https://download.pushtechnology.com/docs/6.5.2/js/globals.html#log) method. | ||
* The client can check its connectivity and roundtrip time to the server by using the | ||
[pingServer](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#pingserver) method. | ||
[pingServer](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#pingserver) method. | ||
@@ -213,11 +213,11 @@ | ||
Use the | ||
[session.select](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#select) | ||
[session.select](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#select) | ||
method to subscribe to a topic. The updates to a topic can be interacted with by registering a | ||
[ValueStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/valuestream.html) and | ||
[ValueStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/valuestream.html) and | ||
a provided datatype to start receiving the values of that datatype. | ||
* Fetch data from topics. | ||
Use the [fetch](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/session.html#fetch) | ||
Use the [fetch](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/session.html#fetch) | ||
method to make a fetch request and get a | ||
[FetchStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/fetchstream.html) | ||
[FetchStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/fetchstream.html) | ||
object that you can use to receive fetched values. | ||
@@ -228,8 +228,8 @@ | ||
Creating and managing topics is handled through the [topics](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topiccontrol.html) feature. | ||
Creating and managing topics is handled through the [topics](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topiccontrol.html) feature. | ||
* Add a topic. | ||
Use the [add](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topiccontrol.html#add) | ||
Use the [add](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topiccontrol.html#add) | ||
method to add a topic. You can create a topic by explicitly defining the topic type, or by providing a | ||
[TopicSpecification](https://download.pushtechnology.com/docs/6.5.1/js/classes/topicspecification.html) | ||
[TopicSpecification](https://download.pushtechnology.com/docs/6.5.2/js/classes/topicspecification.html) | ||
with optional properties. | ||
@@ -239,7 +239,7 @@ | ||
Use the | ||
[addMissingTopicHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topiccontrol.html#addmissingtopichandler) | ||
[addMissingTopicHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topiccontrol.html#addmissingtopichandler) | ||
method to register a | ||
[MissingTopicHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/missingtopichandler.html). | ||
[MissingTopicHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/missingtopichandler.html). | ||
This handler receives a | ||
[MissingTopicNotification](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/missingtopicnotification.html) | ||
[MissingTopicNotification](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/missingtopicnotification.html) | ||
when a client session subscribes to a topic that does not currently exist. The notified client can then choose to | ||
@@ -250,5 +250,5 @@ create that topic if appropriate. | ||
Use the | ||
[remove](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topiccontrol.html#remove) | ||
[remove](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topiccontrol.html#remove) | ||
method to remove topics. You can also mark topics to be removed automatically with the TopicSpecification property | ||
[REMOVAL](https://download.pushtechnology.com/docs/6.5.1/js/classes/topicspecification.html#removal). | ||
[REMOVAL](https://download.pushtechnology.com/docs/6.5.2/js/classes/topicspecification.html#removal). | ||
@@ -258,11 +258,11 @@ | ||
Updating topics is handled through the [topicUpdate](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicupdate.html) feature. | ||
Updating topics is handled through the [topicUpdate](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicupdate.html) feature. | ||
* Update a topic using the [set](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicupdate.html#set) method. | ||
* Update a topic using the [set](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicupdate.html#set) method. | ||
* Create an update stream for creating and updating a specific topic using the | ||
[createUpdateStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/topicupdate.html#createupdatestream) | ||
[createUpdateStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/topicupdate.html#createupdatestream) | ||
* Update topics by using the classes in the | ||
[diffusion.datatypes](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/datatypes.html) | ||
[diffusion.datatypes](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/datatypes.html) | ||
namespace to create update values. | ||
@@ -273,9 +273,9 @@ | ||
Updating topics is handled through the [clients](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/clientcontrol.html) feature. | ||
Updating topics is handled through the [clients](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/clientcontrol.html) feature. | ||
* Subscribe other client sessions to topics. | ||
Use the | ||
[subscribe](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/clientcontrol.html#subscribe) | ||
[subscribe](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/clientcontrol.html#subscribe) | ||
and | ||
[unsubscribe](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/clientcontrol.html#unsubscribe) | ||
[unsubscribe](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/clientcontrol.html#unsubscribe) | ||
methods to manage another client session's subscriptions. | ||
@@ -285,5 +285,5 @@ | ||
Use the | ||
[setSessionPropertiesListener](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/clientcontrol.html#setsessionpropertieslistener) | ||
[setSessionPropertiesListener](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/clientcontrol.html#setsessionpropertieslistener) | ||
method to register a | ||
[SessionPropertiesListener](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/sessionpropertieslistener.html) | ||
[SessionPropertiesListener](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/sessionpropertieslistener.html) | ||
to receive notifications for session events or when a session changes properties. | ||
@@ -293,5 +293,5 @@ | ||
Use the | ||
[getSessionProperties](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/clientcontrol.html#getsessionproperties) | ||
[getSessionProperties](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/clientcontrol.html#getsessionproperties) | ||
method. Specify which sets of properties to receive using | ||
[PropertyKeys](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/propertykeys.html). | ||
[PropertyKeys](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/propertykeys.html). | ||
@@ -301,7 +301,7 @@ | ||
Sending and receiving messages is handled through the [messages](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/messages.html) feature. | ||
Sending and receiving messages is handled through the [messages](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/messages.html) feature. | ||
* Send a message. | ||
Use the | ||
[send](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/messages.html#sendrequest) | ||
[send](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/messages.html#sendrequest) | ||
method to either send a message to a specific client session or send a message to a path. | ||
@@ -311,11 +311,11 @@ | ||
Use the | ||
[setRequestStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/messages.html#setrequeststream) | ||
[setRequestStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/messages.html#setrequeststream) | ||
method to receive messages sent to this client session through a | ||
[RequestStream](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/requeststream.html). | ||
[RequestStream](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/requeststream.html). | ||
* Receive messages sent to a path. | ||
Use the | ||
[addRequestHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/messages.html#addrequesthandler) | ||
[addRequestHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/messages.html#addrequesthandler) | ||
method to register a | ||
[RequestHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/requesthandler.html) | ||
[RequestHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/requesthandler.html) | ||
that receives messages sent to a path. | ||
@@ -326,9 +326,9 @@ | ||
Authenticating clients and modifying the authentication store is handled through the [security](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html) feature. | ||
Authenticating clients and modifying the authentication store is handled through the [security](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html) feature. | ||
* Register an authentication handler to authenticate other client sessions. | ||
Implement an | ||
[AuthenticationHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/authenticationhandler.html) | ||
[AuthenticationHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/authenticationhandler.html) | ||
and use the | ||
[setAuthenticationHandler](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#setauthenticationhandler) | ||
[setAuthenticationHandler](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#setauthenticationhandler) | ||
method to register it with the server. | ||
@@ -339,11 +339,11 @@ | ||
* Get the system authentication store information with the | ||
[getSystemAuthenticationConfiguration](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#getsystemauthenticationconfiguration) method. | ||
[getSystemAuthenticationConfiguration](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#getsystemauthenticationconfiguration) method. | ||
* Update the system authentication store. | ||
Use the | ||
[authenticationScriptBuilder](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#authenticationscriptbuilder) | ||
[authenticationScriptBuilder](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#authenticationscriptbuilder) | ||
method to get a | ||
[SystemAuthenticationScriptBuilder](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/systemauthenticationscriptbuilder.html). | ||
[SystemAuthenticationScriptBuilder](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/systemauthenticationscriptbuilder.html). | ||
The builder can be used to create a script. Pass the script to the | ||
[updateAuthenticationStore](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#updateauthenticationstore) | ||
[updateAuthenticationStore](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#updateauthenticationstore) | ||
method to update the system authentication store. | ||
@@ -354,13 +354,13 @@ | ||
The [security](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html) feature also allows querying and updating a session's security roles. | ||
The [security](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html) feature also allows querying and updating a session's security roles. | ||
* Get the security store information [getSecurityConfiguration](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#getsecurityconfiguration) method. | ||
* Get the security store information [getSecurityConfiguration](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#getsecurityconfiguration) method. | ||
* Update the security store. | ||
Use the | ||
[securityScriptBuilder](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#securityscriptbuilder) | ||
[securityScriptBuilder](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#securityscriptbuilder) | ||
method to get a | ||
[SecurityScriptBuilder](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/securityscriptbuilder.html). | ||
[SecurityScriptBuilder](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/securityscriptbuilder.html). | ||
The builder can be used to create a script. Pass the script to the | ||
[updateSecurityStore](https://download.pushtechnology.com/docs/6.5.1/js/interfaces/security.html#updatesecuritystore) | ||
[updateSecurityStore](https://download.pushtechnology.com/docs/6.5.2/js/interfaces/security.html#updatesecuritystore) | ||
method to update the system authentication store. |
@@ -34,7 +34,7 @@ "use strict"; | ||
*/ | ||
exports.version = '6.5.1'; | ||
exports.version = '6.5.2'; | ||
/** | ||
* The build version of this client library | ||
*/ | ||
exports.build = '71332'; | ||
exports.build = '72419'; | ||
/** | ||
@@ -41,0 +41,0 @@ * Set the level of logging used by Diffusion. This will default to silent. |
Sorry, the diff of this file is too big to display