Class SendMessageWebSocket
Extends
CompositionItem.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Represents an SendMessageWebSocket within the Composition.
|
| Field Attributes | Field Name and Description |
|---|---|
| {boolean} |
True if this Send Message WebSocket had any validation failures.
|
| {Target} |
The Target object for this Send Message WebSocket.
|
| {String} |
The value "Send Message 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 Send Message WebSocket.
|
- Methods borrowed from class CompositionItem:
- clearRepeat, end, endRepeat, getChild, getItemViaPath, setRepeat
Field Detail
{boolean}
hasValidationFailures
True if this Send Message WebSocket had any validation failures.
False until the Send Message WebSocket plays. If the Send Message WebSocket never plays, remains false.
Read only.
{Target}
target
The Target object for this Send Message WebSocket. Can be null.
Read only.
{String}
type
The value "Send Message WebSocket". Read only.
Method Detail
clearResponse()
Clears any current response from memory.
Can be used after the Send Message WebSocket plays to free up the memory used to hold the response if the Send Message WebSocket does not have scope "private".
If the Send Message 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 Send Message WebSocket.
If the Send Message WebSocket did not return any output, or the Send Message WebSocket has not been played yet, null is returned.
- Returns:
- The output from the Send Message WebSocket.