包 | mx.rpc |
类 | public dynamic class AbstractService |
继承 | AbstractService Proxy Object |
实现 | IEventDispatcher |
子类 | AbstractWebService, RemoteObject |
属性 | 定义方 | ||
---|---|---|---|
channelSet : ChannelSet 提供对服务使用的 ChannelSet 的访问。 | AbstractService | ||
constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | ||
destination : String 服务的目标。 | AbstractService | ||
operations : Object 如果使用 MXML 标签创建服务,则操作数组通常仅由 MXML 编译器设置。 | AbstractService | ||
prototype : Object [静态]
对类或函数对象的原型对象的引用。 | Object | ||
requestTimeout : int 提供对已发送消息的请求超时(以秒为单位)的访问。 | AbstractService |
方法 | 定义方 | ||
---|---|---|---|
AbstractService(destination:String = null) 构造函数。 | AbstractService | ||
断开此服务的网络连接并删除任何未处理的请求 responder。 | AbstractService | ||
返回给定名称的操作。 | AbstractService | ||
指示对象是否已经定义了指定的属性。 | Object | ||
指示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | ||
将用户从目标中注销。 | AbstractService | ||
指示指定的属性是否存在、是否可枚举。 | Object | ||
当在服务器端使用 Data Services 时,为服务访问的目标设置凭据。 | AbstractService | ||
设置循环操作动态属性的可用性。 | Object | ||
当在服务器端使用 Data Services 时,用于在访问远程第三方端点(例如通过代理访问 Web 服务或通过自定义适配器访问远程对象)时对用户进行身份验证的用户名和密码。 | AbstractService | ||
返回指定对象的字符串表示形式。 | Object | ||
返回指定对象的原始值。 | Object |
事件 | 摘要 | 定义方 | ||
---|---|---|---|---|
当服务调用失败并且操作自身不处理时,将调度 fault 事件。 | AbstractService | |||
当调用服务操作时,只要在通道尝试发送消息前没有引发错误,将调度 invoke 事件。 | AbstractService | |||
当服务调用成功返回并且操作自身不处理时,将调度 result 事件。 | AbstractService |
channelSet | 属性 |
channelSet:ChannelSet
[读写]
提供对服务使用的 ChannelSet 的访问。可以手动构造并分配 ChannelSet,否则将动态创建 以使用为此服务的
配置的通道。
public function get channelSet():ChannelSet
public function set channelSet(value:ChannelSet):void
destination | 属性 |
destination:String
[读写] 服务的目标。该值应与 services-config.xml 文件中的目标条目匹配。
public function get destination():String
public function set destination(value:String):void
operations | 属性 |
operations:Object
[读写] 如果使用 MXML 标签创建服务,则操作数组通常仅由 MXML 编译器设置。
public function get operations():Object
public function set operations(value:Object):void
requestTimeout | 属性 |
requestTimeout:int
[读写] 提供对已发送消息的请求超时(以秒为单位)的访问。如果值小于 0 或等于 0,则可阻止请求超时的发生。
public function get requestTimeout():int
public function set requestTimeout(value:int):void
AbstractService | () | 构造函数 |
public function AbstractService(destination:String = null)
构造函数。
参数destination:String (default = null ) — 服务的目标。 |
disconnect | () | 方法 |
public function disconnect():void
断开此服务的网络连接并删除任何未处理的请求 responder。此方法不会等待未完成的网络操作完成。
getOperation | () | 方法 |
public function getOperation(name:String):AbstractOperation
返回给定名称的操作。如果之前没有创建操作,则子类将负责在此调用过程中创建该操作。通常只需在服务变量之后命名操作即可访问操作 (myService.someOperation
),但如果 Operation 的名称恰好与服务上所定义的方法(如 setCredentials
)相匹配,则可以改用此方法来获取 Operation。
参数
name:String — 操作的名称。 |
AbstractOperation — 为此名称执行的操作。 |
logout | () | 方法 |
public function logout():void
将用户从目标中注销。从目标中注销适用于使用在服务器配置中指定的同一 ChannelSet 连接的所有对象。例如,如果通过 my-rtmp 通道连接并且使用 RPC 组件之一注销,则通过同一 ChannelSet 连接的任何内容都将被注销。
setCredentials | () | 方法 |
public function setCredentials(username:String, password:String, charset:String = null):void
当在服务器端使用 Data Services 时,为服务访问的目标设置凭据。凭据适用于通过相同 ChannelSet 连接的所有服务。请注意,使用代理或第三方适配器连接到远程端点的服务将需要 setRemoteCredentials。
参数
username:String — 目标的用户名。 | |
password:String — 目标的密码。 | |
charset:String (default = null ) — 对凭据进行编码时使用的字符集编码。默认值为 null,表示旧字符集 ISO-Latin-1。其它受支持的字符集仅有“UTF-8”。 |
setRemoteCredentials | () | 方法 |
public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
当在服务器端使用 Data Services 时,用于在访问远程第三方端点(例如通过代理访问 Web 服务或通过自定义适配器访问远程对象)时对用户进行身份验证的用户名和密码。
参数
remoteUsername:String — 要传递给远程端点的用户名 | |
remotePassword:String — 要传递给远程端点的密码 | |
charset:String (default = null ) — 对远程凭据进行编码时使用的字符集编码。默认值为 null,表示旧字符集 ISO-Latin-1。其它受支持的字符集仅有“UTF-8”。 |
fault | 事件 |
mx.rpc.events.FaultEvent
mx.rpc.events.FaultEvent.FAULT
当服务调用失败并且操作自身不处理时,将调度 fault 事件。
FAULT 事件类型。事件对象的属性有下列值:
属性 | 值 |
---|---|
bubbles
| false |
cancelable
| true,通过关联标记的 responder.fault 方法调用 preventDefault() 将防止服务或操作调度此事件。 |
currentTarget
|
用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
|
fault
| 包含导致此事件原因的详细信息的 Fault 对象。 |
message
| 与此事件相关联的 Message。 |
target
|
调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
|
token
| 表示方法调用的标记。用于异步完成标记模式。 |
invoke | 事件 |
mx.rpc.events.InvokeEvent
mx.rpc.events.InvokeEvent.INVOKE
当调用服务操作时,只要在通道尝试发送消息前没有引发错误,将调度 invoke 事件。
INVOKE 事件类型。事件对象的属性有下列值:
属性 | 值 |
---|---|
bubbles
| false |
token
| 表示对方法单独调用的标记。用于异步完成标记模式。 |
cancelable
| true |
currentTarget
|
用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
|
message
| 与此事件关联的请求 Message。 |
target
|
调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
|
result | 事件 |
mx.rpc.events.ResultEvent
mx.rpc.events.ResultEvent.RESULT
当服务调用成功返回并且操作自身不处理时,将调度 result 事件。
RESULT 事件类型。事件对象的属性有下列值:
属性 | 值 |
---|---|
bubbles
| false |
cancelable
| true,通过关联标记的 responder.result 方法调用 preventDefault() 将防止服务或操作调度此事件。 |
currentTarget
|
用于定义处理该事件的事件侦听器的 Object。例如,如果您使用 myButton.addEventListener() 注册某个事件侦听器,则 myButton 为 currentTarget 的值。
|
message
| 与此事件相关联的 Message。 |
target
|
调度该事件的 Object;它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。
|
result
| RPC 调用返回的结果。 |
token
| 表示对方法单独调用的标记。用于异步完成标记模式。 |