| 包 | mx.messaging.messages |
| 类 | public class CommandMessage |
| 继承 | CommandMessage  AsyncMessage AbstractMessage Object |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | body : Object
消息正文包含需要传递到远程目标的特定数据。 | AbstractMessage | |
| clientId : String
ClientId 指示发送消息的 MessageAgent。 | AbstractMessage | |
| constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| correlationId : String
提供对此消息的相关 ID 的访问权限。 | AsyncMessage | |
| destination : String
消息目标。 | AbstractMessage | |
| headers : Object
消息标头是一个关联数组，其中关键字为标头名称，而值为标头值。 | AbstractMessage | |
| messageId : String
消息的唯一 ID。 | AbstractMessage | |
| operation : uint
提供对 CommandMessage 的操作/命令的访问权限。 | CommandMessage | ||
| timestamp : Number
提供对消息时间戳的访问权限。 | AbstractMessage | |
| timeToLive : Number
消息的生存时间值指示该消息应视为有效且可传送的时间。 | AbstractMessage | |
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
构造正文和标头为空，默认操作为 UNKNOWN_OPERATION 的 CommandMessage 实例。 | CommandMessage | ||
[静态]
提供对指定操作的描述。 | CommandMessage | ||
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
[覆盖]
返回消息的字符串表示形式。 | CommandMessage | ||
|
返回指定对象的原始值。 | Object | |
公共常量
| 常量 | 由以下参数定义 | ||
|---|---|---|---|
| ADD_SUBSCRIPTIONS : String = "DSAddSub" [静态]
MULTI_SUBSCRIBE 消息中使用的标头，用于指定要添加到现有的一组 subscriptions 的 子主题/选择器对数组。 | CommandMessage | ||
| AUTHENTICATION_MESSAGE_REF_TYPE : String = "flex.messaging.messages.AuthenticationMessage" [静态]
身份验证命令的服务器消息类型。 | CommandMessage | ||
| CLIENT_PING_OPERATION : uint = 5 [静态]
此操作用于测试通过当前通道到远程端点的连接性。 | CommandMessage | ||
| CLIENT_SYNC_OPERATION : uint = 4 [静态]
在客户端发出轮询命令后，远程目标通过此操作将漏掉或缓存的消息同步回客户端。 | CommandMessage | ||
| CLUSTER_REQUEST_OPERATION : uint = 7 [静态]
此操作用于根据群集成员身份请求远程目标故障转移端点的 URI 列表。 | CommandMessage | ||
| CREDENTIALS_CHARSET_HEADER : String = "DSCredentialsCharset" [静态]
指定对登录凭据进行编码时所使用的字符集编码的标头。 | CommandMessage | ||
| DISCONNECT_OPERATION : uint = 12 [静态]
此操作用于指示通道已断开。 | CommandMessage | ||
| HEARTBEAT_HEADER : String = "DS<3" [静态]
指示消息是检测信号的标头。 | CommandMessage | ||
| LOGIN_OPERATION : uint = 8 [静态]
此操作用于向端点发送凭据，以便用户可通过当前通道登录。 | CommandMessage | ||
| LOGOUT_OPERATION : uint = 9 [静态]
此操作用于将用户从当前通道中注销；如果该通道基于 HTTP，则会使服务器会话失效。 | CommandMessage | ||
| MAX_FREQUENCY_HEADER : String = "DSMaxFrequency" [静态]
用来指示使用者希望每秒钟收到的消息的最大数量的头。 | CommandMessage | ||
| MESSAGING_VERSION : String = "DSMessagingVersion" [静态]
通过在进行初始 ping CommandMessage 的握手期间报告所能够支持的最新消息传送版本，端点可指示它们支持的功能。 | CommandMessage | ||
| MULTI_SUBSCRIBE_OPERATION : uint = 11 [静态]
供 MultiTopicConsumer 用于在同一消息中订阅或取消订阅同一消息中的多个主题。 | CommandMessage | ||
| NEEDS_CONFIG_HEADER : String = "DSNeedsConfig" [静态]
指示 Channel 需要服务器中配置的标头。 | CommandMessage | ||
| NO_OP_POLL_HEADER : String = "DSNoOpPoll" [静态]
禁止处理轮询响应的标头。 | CommandMessage | ||
| POLL_OPERATION : uint = 2 [静态]
此操作用于轮询未处理、未传递的消息的远程目标。 | CommandMessage | ||
| POLL_WAIT_HEADER : String = "DSPollWait" [静态]
强迫在请求下一次客户端轮询前需经历空闲等待时间的标头。 | CommandMessage | ||
| PRESERVE_DURABLE_HEADER : String = "DSPreserveDurable" [静态]
当取消订阅消息在标头中将此参数设置为 true 时，将保留持久的 JMS subscriptions。 | CommandMessage | ||
| REMOVE_SUBSCRIPTIONS : String = "DSRemSub" [静态]
如上所述，但指定要删除的子主题/选择器数组
| CommandMessage | ||
| SELECTOR_HEADER : String = "DSSelector" [静态]
Consumer 发出的订阅命令在此标头中传递 Consumer 的选择器表达式。 | CommandMessage | ||
| SUBSCRIBE_OPERATION : uint = 0 [静态]
此操作用于订阅远程目标。 | CommandMessage | ||
| SUBSCRIPTION_INVALIDATE_OPERATION : uint = 10 [静态]
此操作用于指示客户端的远程目标订阅已超时。 | CommandMessage | ||
| SUBTOPIC_SEPARATOR : String = "_;_" [静态]
在添加和删除订阅标头过程中用于分隔 subtopic 和 selector 的分隔符字符串。 | CommandMessage | ||
| TRIGGER_CONNECT_OPERATION : uint = 13 [静态]
此操作用于触发要连接的 ChannelSet。 | CommandMessage | ||
| UNKNOWN_OPERATION : uint = 10000 [静态]
这是新 CommandMessage 实例的默认操作。 | CommandMessage | ||
| UNSUBSCRIBE_OPERATION : uint = 1 [静态]
此操作用于从远程目标取消订阅。 | CommandMessage | ||
属性详细信息
operation | 属性 |
public var operation:uint| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
提供对 CommandMessage 的操作/命令的访问权限。Operation 指示远程目标如何处理此消息。
构造函数详细信息
CommandMessage | () | 构造函数 |
public function CommandMessage()| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
构造正文和标头为空，默认 operation 为 UNKNOWN_OPERATION 的 CommandMessage 实例。
方法详细信息
getOperationAsString | () | 方法 |
public static function getOperationAsString(op:uint):String| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
提供对指定操作的描述。使用此方法对该消息进行 toString() 操作。
参数
op:uint — CommandMessage 操作常量之一。
|
String — 操作的短名称。
|
示例
如何使用本示例
var msg:CommandMessage = CommandMessage(event.message);
trace("Current operation -'"+
CommandMessage.getOperationAsString(msg.operation)+ "'.");
toString | () | 方法 |
常量详细信息
ADD_SUBSCRIPTIONS | 常量 |
public static const ADD_SUBSCRIPTIONS:String = "DSAddSub"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
MULTI_SUBSCRIBE 消息中使用的标头，用于指定要添加到现有的一组 subscriptions 的 子主题/选择器对数组。
AUTHENTICATION_MESSAGE_REF_TYPE | 常量 |
public static const AUTHENTICATION_MESSAGE_REF_TYPE:String = "flex.messaging.messages.AuthenticationMessage"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
身份验证命令的服务器消息类型。
CLIENT_PING_OPERATION | 常量 |
public static const CLIENT_PING_OPERATION:uint = 5| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于测试通过当前通道到远程端点的连接性。
CLIENT_SYNC_OPERATION | 常量 |
public static const CLIENT_SYNC_OPERATION:uint = 4| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
在客户端发出轮询命令后，远程目标通过此操作将漏掉或缓存的消息同步回客户端。
CLUSTER_REQUEST_OPERATION | 常量 |
public static const CLUSTER_REQUEST_OPERATION:uint = 7| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于根据群集成员身份请求远程目标故障转移端点的 URI 列表。
CREDENTIALS_CHARSET_HEADER | 常量 |
public static const CREDENTIALS_CHARSET_HEADER:String = "DSCredentialsCharset"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指定对登录凭据进行编码时所使用的字符集编码的标头。
DISCONNECT_OPERATION | 常量 |
public static const DISCONNECT_OPERATION:uint = 12| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于指示通道已断开。
HEARTBEAT_HEADER | 常量 |
public static const HEARTBEAT_HEADER:String = "DS<3"指示消息是检测信号的标头。
LOGIN_OPERATION | 常量 |
public static const LOGIN_OPERATION:uint = 8| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于向端点发送凭据，以便用户可通过当前通道登录。凭据需要为 Base64 编码格式并存储在消息的 body 中。
LOGOUT_OPERATION | 常量 |
public static const LOGOUT_OPERATION:uint = 9| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于将用户从当前通道中注销；如果该通道基于 HTTP，则会使服务器会话失效。
MAX_FREQUENCY_HEADER | 常量 |
public static const MAX_FREQUENCY_HEADER:String = "DSMaxFrequency"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
用来指示使用者希望每秒钟收到的消息的最大数量的头。
MESSAGING_VERSION | 常量 |
public static const MESSAGING_VERSION:String = "DSMessagingVersion"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
通过在进行初始 ping CommandMessage 的握手期间报告所能够支持的最新消息传送版本，端点可指示它们支持的功能。
MULTI_SUBSCRIBE_OPERATION | 常量 |
public static const MULTI_SUBSCRIBE_OPERATION:uint = 11| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
供 MultiTopicConsumer 用于在同一消息中订阅或取消订阅同一消息中的多个主题。
NEEDS_CONFIG_HEADER | 常量 |
public static const NEEDS_CONFIG_HEADER:String = "DSNeedsConfig"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指示 Channel 需要服务器中配置的标头。
NO_OP_POLL_HEADER | 常量 |
public static const NO_OP_POLL_HEADER:String = "DSNoOpPoll"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
禁止处理轮询响应的标头。如果客户端已经向服务器提交了一个长轮询并发出了另一个轮询，则应使用此标头作为该后续轮询响应的标签：在此情况下，会将该响应视为 no-op（无操作），且不会调度下一个轮询。如果没有此标头，后续的轮询会将通道和端点置于繁忙的轮询循环中。
POLL_OPERATION | 常量 |
public static const POLL_OPERATION:uint = 2| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于轮询未处理、未传递的消息的远程目标。
POLL_WAIT_HEADER | 常量 |
public static const POLL_WAIT_HEADER:String = "DSPollWait"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
强迫在请求下一次客户端轮询前需经历空闲等待时间的标头。
PRESERVE_DURABLE_HEADER | 常量 |
public static const PRESERVE_DURABLE_HEADER:String = "DSPreserveDurable"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当取消订阅消息在标头中将此参数设置为 true 时，将保留持久的 JMS subscriptions。
REMOVE_SUBSCRIPTIONS | 常量 |
public static const REMOVE_SUBSCRIPTIONS:String = "DSRemSub"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
如上所述，但指定要删除的子主题/选择器数组
SELECTOR_HEADER | 常量 |
public static const SELECTOR_HEADER:String = "DSSelector"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
Consumer 发出的订阅命令在此标头中传递 Consumer 的 selector 表达式。
SUBSCRIBE_OPERATION | 常量 |
public static const SUBSCRIBE_OPERATION:uint = 0| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于订阅远程目标。
SUBSCRIPTION_INVALIDATE_OPERATION | 常量 |
public static const SUBSCRIPTION_INVALIDATE_OPERATION:uint = 10| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于指示客户端的远程目标订阅已超时。
SUBTOPIC_SEPARATOR | 常量 |
public static const SUBTOPIC_SEPARATOR:String = "_;_"| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
在添加和删除订阅标头过程中用于分隔 subtopic 和 selector 的分隔符字符串。
TRIGGER_CONNECT_OPERATION | 常量 |
public static const TRIGGER_CONNECT_OPERATION:uint = 13| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于触发要连接的 ChannelSet。
UNKNOWN_OPERATION | 常量 |
public static const UNKNOWN_OPERATION:uint = 10000| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
这是新 CommandMessage 实例的默认操作。
UNSUBSCRIBE_OPERATION | 常量 |
public static const UNSUBSCRIBE_OPERATION:uint = 1| 语言版本: | ActionScript 3.0 |
| 产品版本: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
此操作用于从远程目标取消订阅。
Tue Jun 12 2018, 11:04 AM Z