Class OpenWebSocket
Extends
CompositionItem.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Represents an OpenWebSocket within the Composition.
|
| Field Attributes | Field Name and Description |
|---|---|
| {boolean} |
True if this Open WebSocket had any validation failures.
|
| {Target} |
The Target object for this Open WebSocket.
|
| {String} |
The value "Open WebSocket".
|
- Fields borrowed from class CompositionItem:
- children, completionType, failureText, forEachValue, hasErrorEvents, index, name, nextItem, parent, path, playNumber, playNumberBeforeRenewal, playNumberWithinRenewal, previousItem, propertyList, REPEAT_DISTRIBUTION_CONSTANT, REPEAT_TIMING_PARALLEL, REPEAT_TIMING_SERIAL, REPEAT_TYPE_COUNT_CONSTANT, repeatIndex, systemPropertyList
| Method Attributes | Method Name and Description |
|---|---|
|
Clears any current response from memory.
|
|
|
Returns a string containing the output of the Open WebSocket.
|
- Methods borrowed from class CompositionItem:
- clearRepeat, end, endRepeat, getChild, getItemViaPath, setRepeat
Field Detail
{boolean}
hasValidationFailures
True if this Open WebSocket had any validation failures.
False until the Open WebSocket plays. If the Open WebSocket never plays, remains false.
Read only.
{Target}
target
The Target object for this Open WebSocket. Can be null.
Read only.
{String}
type
The value "Open WebSocket". Read only.
Method Detail
clearResponse()
Clears any current response from memory.
Can be used after the Open WebSocket plays to free up the memory used to hold the response if the Open WebSocket does not have scope "private".
If the Open WebSocket has scope private, this call is not necessary, since the memory will be freed automatically by the system when it goes out of scope.
getResponse()
Returns a string containing the output of the Open WebSocket.
If the Open WebSocket did not return any output, or the Open WebSocket has not been played yet, null is returned.
- Returns:
- The output from the Open WebSocket.