| { "type": "class", | |
| "qname": "mx.messaging.messages.CommandMessage", | |
| "baseClassname": "mx.messaging.messages.AsyncMessage" | |
| , | |
| "description": "The CommandMessage class provides a mechanism for sending commands to the server infrastructure, such as commands related to publish/subscribe messaging scenarios, ping operations, and cluster operations.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "members": [ | |
| { "type": "field", | |
| "qname": "SUBSCRIBE_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to subscribe to a remote destination.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "UNSUBSCRIBE_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to unsubscribe from a remote destination.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "POLL_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to poll a remote destination for pending, undelivered messages.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "CLIENT_SYNC_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used by a remote destination to sync missed or cached messages back to a client as a result of a client issued poll command.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "CLIENT_PING_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to test connectivity over the current channel to the remote endpoint.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "CLUSTER_REQUEST_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to request a list of failover endpoint URIs for the remote destination based on cluster membership.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "LOGIN_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to send credentials to the endpoint so that the user can be logged in over the current channel. The credentials need to be Base64 encoded and stored in the <code>body</code> of the message.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "LOGOUT_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to log the user out of the current channel, and will invalidate the server session if the channel is HTTP based.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "MESSAGING_VERSION", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Endpoints can imply what features they support by reporting the latest version of messaging they are capable of during the handshake of the initial ping CommandMessage.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "SUBSCRIPTION_INVALIDATE_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to indicate that the client's subscription with a remote destination has timed out.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "MULTI_SUBSCRIBE_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Used by the MultiTopicConsumer to subscribe/unsubscribe for more than one topic in the same message.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "DISCONNECT_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to indicate that a channel has disconnected.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "TRIGGER_CONNECT_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This operation is used to trigger a ChannelSet to connect.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "UNKNOWN_OPERATION", | |
| "return": "uint", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "This is the default operation for new CommandMessage instances.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "AUTHENTICATION_MESSAGE_REF_TYPE", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "The server message type for authentication commands.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "SELECTOR_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Subscribe commands issued by a Consumer pass the Consumer's <code>selector</code> expression in this header.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "PRESERVE_DURABLE_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Durable JMS subscriptions are preserved when an unsubscribe message has this parameter set to true in its header.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "NEEDS_CONFIG_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header to indicate that the Channel needs the configuration from the server.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "ADD_SUBSCRIPTIONS", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header used in a MULTI_SUBSCRIBE message to specify an Array of subtopic/selector pairs to add to the existing set of subscriptions.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "REMOVE_SUBSCRIPTIONS", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Like the above, but specifies the subtopic/selector array of to remove", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "SUBTOPIC_SEPARATOR", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "The separator string used for separating subtopic and selectors in the add and remove subscription headers.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "POLL_WAIT_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header to drive an idle wait time before the next client poll request.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "NO_OP_POLL_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header to suppress poll response processing. If a client has a long-poll parked on the server and issues another poll, the response to this subsequent poll should be tagged with this header in which case the response is treated as a no-op and the next poll will not be scheduled. Without this, a subsequent poll will put the channel and endpoint into a busy polling cycle.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "CREDENTIALS_CHARSET_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header to specify which character set encoding was used while encoding login credentials.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "MAX_FREQUENCY_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header to indicate the maximum number of messages a Consumer wants to receive per second.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "HEARTBEAT_HEADER", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Header that indicates the message is a heartbeat."}, | |
| { "type": "method", | |
| "qname": "mx.messaging.messages.CommandMessage", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructs an instance of a CommandMessage with an empty body and header and a default <code>operation</code> of <code>UNKNOWN_OPERATION</code>.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": []} | |
| , | |
| { "type": "accessor", | |
| "access": "read-write", | |
| "return": "uint", | |
| "qname": "operation", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Provides access to the operation/command for the CommandMessage. Operations indicate how this message should be processed by the remote destination.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "getOperationAsString", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Provides a description of the operation specified. This method is used in <code>toString()</code> operations on this message. <code><pre>\\n var msg:CommandMessage = CommandMessage(event.message);\\n trace("Current operation -'"+\\n CommandMessage.getOperationAsString(msg.operation)+ "'.");\\n </pre></code>", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["op One of the CommandMessage operation constants."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["Short name for the operation."]}, | |
| { "tagName": "example", | |
| "values": []}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "String", | |
| "params": [{ "name": "op", "type": "uint"}]} | |
| ] | |
| } |