Constructor
new DocumentStreamBuilder(streamServerUrlnon-null, wicaStreamPropertyDefaultsnon-null, wicaElementConnectionAttributesnon-null)
Constructs a new instance to work with the specified backend server.
The returned object will remain in a dormant state until triggered by a call to the
activate method.
Parameters:
| Name | Type | Description |
|---|---|---|
streamServerUrl |
string | The URL of the backend server from whom information is to be obtained. |
wicaStreamPropertyDefaults |
module:shared-definitions.WicaStreamProperties | The default properties for the streams created by this builder. Individual stream properties may be overridden by the explicit definitions on the wica stream HTML elements. See WicaStreamProperties. |
wicaElementConnectionAttributes |
module:shared-definitions.WicaElementConnectionAttributes | The names of the HTML element attributes that are to be used in the wica communication process. See WicaElementConnectionAttributes. |
Methods
activate()
Scans the current document for wica-stream elements, creates streams on the Wica backend server to obtain
information for each element's data source, sets up handlers to update each element's attributes on
the basis of the received information.
See also: shutdown.
shutdown()
Shuts down the streams that were earlier built by this class.
See also: activate.