mx.rpc.soap
public dynamic class WebService
继承WebService Inheritance AbstractWebService Inheritance AbstractService Inheritance Proxy Inheritance Object
子类 WebService

WebService 类提供对远程服务器上基于 SOAP 的 Web 服务的访问。



公共属性
 属性定义方
 InheritedchannelSet : ChannelSet
提供对服务使用的 ChannelSet 的访问。
AbstractService
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
 Inheriteddescription : String
当前活动端口的服务描述。
AbstractWebService
 Inheriteddestination : String
服务的目标。
AbstractWebService
 InheritedendpointURI : String
WebService 的位置。
AbstractWebService
 Inheritedheaders : Array
[只读 (read-only)] 返回为 WebService 注册的 SOAPHeaders 数组。
AbstractWebService
 InheritedhttpHeaders : Object
发送到 SOAP 端点的自定义 HTTP 标头。
AbstractWebService
 InheritedmakeObjectsBindable : Boolean
当该置为 true 时,返回的匿名对象将强制成为可绑定的对象。
AbstractWebService
 Inheritedoperations : Object
如果使用 MXML 标签创建服务,则操作数组通常仅由 MXML 编译器设置。
AbstractService
 Inheritedport : String
指定此 WebService 应使用的 WSDL 文档中的端口.
AbstractWebService
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
 Inheritedready : Boolean
[只读 (read-only)] 指定 WebService 是否准备好发送请求。
AbstractWebService
 InheritedrequestTimeout : int
提供对已发送消息的请求超时(以秒为单位)的访问。
AbstractService
 InheritedrootURL : String
WebService 在计算相对 URL 时应使用的 URL。
AbstractWebService
 Inheritedservice : String
指定此 WebService 应使用的 WSDL 文档中的服务。
AbstractWebService
 InheriteduseProxy : Boolean
指定是否使用 Flex 代理服务。
AbstractWebService
  wsdl : String
此 WebService 的 WSDL 文档的位置。
WebService
 InheritedxmlSpecialCharsFilter : Function
用于在对任何简单内容编码之前转义 XML 特殊字符的自定义函数。
AbstractWebService
公共方法
 方法定义方
  
WebService(destination:String = null, rootURL:String = null)
创建一个新的 WebService。
WebService
 Inherited
添加将应用于此 Web 服务所有操作的标头。
AbstractWebService
 Inherited
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
添加将应用于此 WebService 所有操作的标头。
AbstractWebService
  
返回一个布尔值,指示 WebService 是否准备好加载 WSDL(是否指定了有效的目标或 wsdl)。
WebService
 Inherited
清除应用于所有操作的标头。
AbstractWebService
 Inherited
断开此服务的网络连接并删除任何未处理的请求 responder。
AbstractService
 Inherited
getHeader(qname:QName, headerName:String = null):SOAPHeader
如果根据 QName、localName 和 URI 找到匹配项,则返回标头。
AbstractWebService
  
返回给定名称的操作。
WebService
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
  
loadWSDL(uri:String = null):void
指示 WebService 下载 WSDL 文档。
WebService
 Inherited
将用户从目标中注销。
AbstractService
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
 Inherited
removeHeader(qname:QName, headerName:String = null):void
从所有操作中删除具有给定 QName 的标头。
AbstractWebService
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
当在服务器端使用 Data Services 时,为服务访问的目标设置凭据。
AbstractService
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
在访问 webservice 时对用户进行身份验证的用户名和密码。
AbstractWebService
  
将 WebService 的实例表示为字符串,描述如目标 id 和所分配的通道集等重要属性。
WebService
 Inherited
返回指定对象的原始值。
Object
受保护的方法
 方法定义方
  
初始化一个新的 Operation。
WebService
事件
 事件 摘要 定义方
 Inherited当服务调用失败并且操作自身不处理时,将调度 fault 事件。AbstractService
 Inherited当调用服务操作时,只要在通道尝试发送消息前没有引发错误,将调度 invoke 事件。AbstractService
  当已成功加载 WSDL 文档时调度 LoadEvent.LOAD。WebService
 Inherited当服务调用成功返回并且操作自身不处理时,将调度 result 事件。AbstractService
公共常量
 常量定义方
  DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP"
[静态]
WebService
  DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS"
[静态]
WebService
属性详细信息
wsdl属性
wsdl:String  [读写]

此 WebService 的 WSDL 文档的位置。如果使用相对 URL,请确保已指定 rootURL 或者是在 MXML 中创建的 WebService。



实现
    public function get wsdl():String
    public function set wsdl(value:String):void
构造函数详细信息
WebService()构造函数
public function WebService(destination:String = null, rootURL:String = null)

创建一个新的 WebService。目标(如果已指定)应与 services-config.xml 中的条目匹配。如果未指定,WebService 使用 DefaultHTTP 目标。如果打算使用相对 URL 查找此 WebService 的 WSDL 文档,则 rootURL 是必不可少的。

参数
destination:String (default = null) — WebService 的目标,应与 services-config.xml 文件中的目标名称匹配。
 
rootURL:String (default = null) — WebService 的根 URL。
方法详细信息
canLoadWSDL()方法
public function canLoadWSDL():Boolean

返回一个布尔值,指示 WebService 是否准备好加载 WSDL(是否指定了有效的目标或 wsdl)。

返回
Boolean — 如果 WebService 准备好加载 WSDL,则返回 true,否则返回 false
getOperation()方法 
override public function getOperation(name:String):AbstractOperation

返回给定名称的操作。如果之前没有创建该操作,则将在此调用过程中创建一个新的 mx.rpc.soap.Operation。通常只需在服务变量之后命名操作即可访问操作 (myService.someOperation),但如果 Operation 的名称恰好与服务上所定义的方法(如 setCredentials)相匹配,则可以改用此方法来获取 Operation。

参数

name:String — 操作的名称。

返回
AbstractOperation — 为此名称执行的操作。
initializeOperation()方法 
protected function initializeOperation(operation:Operation):void

初始化一个新的 Operation。

参数

operation:Operation — 要初始化的 Operation。

loadWSDL()方法 
public function loadWSDL(uri:String = null):void

指示 WebService 下载 WSDL 文档。当在 WebService MXML 标签中指定时,WebService 自动调用此方法;但是如果在指定 destinationwsdl 属性值后在 ActionScript 中创建 WebService 对象,则必须手动调用此方法。

参数

uri:String (default = null) — 如果之前没有指定 wsdl,可以在此指定。

toString()方法 
public function toString():String

将 WebService 的实例表示为字符串,描述如目标 id 和所分配的通道集等重要属性。

返回
String — 返回 WebService 的 String 表示形式。
事件详细信息
load 事件
事件对象类型: mx.rpc.soap.LoadEvent
属性 LoadEvent.type = mx.rpc.soap.LoadEvent.LOAD

当已成功加载 WSDL 文档时调度 LoadEvent.LOAD

LOAD 常量为 load 事件定义事件对象的 type 属性的值。

事件对象的属性有下列值:

属性
bubbles false
cancelable true
wsdl WSDL 对象。
location WSDL 文档的 URI
常量详细信息
DEFAULT_DESTINATION_HTTP常量
public static const DEFAULT_DESTINATION_HTTP:String = "DefaultHTTP"

DEFAULT_DESTINATION_HTTPS常量 
public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"