Class Lightstreamer
Object
|
+--Lightstreamer
- class
Lightstreamer
Contains all the public objects, classes and functions.
Public aliases for these objects, classes and functions, directly attached
to the "window" object, are also provided, unless the
window.Lightstreamer.avoidLSGlobals flag is used.
Only the global aliases are reported in this API documentation.
Note that, for some classes that are not meant to be instantiated directly,
global aliases are not provided anyway; however, for simplicity, they are
still documented with global names.
Defined in lscommons.js
Field Summary |
<static> boolean |
avoidLSGlobals
Set this flag to true between the inclusion of the lscommons.js and lspushpage.js script tags to
avoid that the Lightstreamer library places its classes under the global namespace (that is, attached to the window
object). |
Constructor Summary |
Lightstreamer
()
Used by Lightstreamer to create a global "window.Lightstreamer" object
that contains all the public objects, classes and functions.
|
avoidLSGlobals
<static> boolean avoidLSGlobals
Set this flag to true between the inclusion of the lscommons.js and lspushpage.js script tags to
avoid that the Lightstreamer library places its classes under the global namespace (that is, attached to the window
object). Anyway, all the classes exposed by the Lightstreamer library are also available under the Lightstreamer namespace
(e.g.: PushPage is always available as Lightstreamer.PushPage).
Instead of using this flag, it is also possible, for cases where a <script> tag is used, to use a ?avoidLSGlobals=true tail to
the path of the lspushpage.js file (e.g.: <script src="/LS/lspushpage.js?avoidLSGlobals=true"></script>). Such technique can't be used
if the lspushpage.js file is downloaded through XMLHttpRequest and then attached to the page through an eval call.
Note that in case the library is included through requireJS or any other AMD loader (see http://wiki.commonjs.org/wiki/Modules/AsynchronousDefinition)
then global aliases are not created and avoidLSGlobals is ignored.
Lightstreamer
Lightstreamer()
Used by Lightstreamer to create a global "window.Lightstreamer" object
that contains all the public objects, classes and functions.
Lightstreamer HTML Client API
Documentation generated by
JSDoc on Tue May 22 11:46:54 2012