Operation

包	mx.rpc.soap
类	public class Operation
继承	Operation AbstractOperation AbstractInvoker EventDispatcher Object
子类	Operation

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

专门由 WebServices 使用的 Operation。Operation 是服务上的单个方法。可以通过在服务上调用同名函数或在服务上访问作为属性的 Operation 并调用 send() 方法来调用 Operation。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		arguments : Object 当操作被调用时传递到此操作的参数。	AbstractOperation
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		endpointURI : String 此 Operation 的 WebService 位置。	Operation
		forcePartArrays : Boolean 确定定义为数组的输出消息部分的单个返回值或空返回值是否应作为包含一个或零个元素的数组返回。	Operation
		headerFormat : String 确定如何解码 SOAP 编码的标头。	Operation
		headers : Array [只读] 要在每次调用操作时发送的 SOAPHeaders 数组的存取器。	Operation
		httpHeaders : Object 发送到 SOAP 端点的自定义 HTTP 标头。	Operation
		ignoreWhitespace : Boolean 确定为 SOAP 编码的请求或响应处理 XML 时是否忽略空格。	Operation
		lastResult : Object [只读] 上次调用的结果。	AbstractInvoker
		makeObjectsBindable : Boolean [覆盖] 当该置为 true 时，返回的匿名对象将强制成为可绑定的对象。	Operation
		multiplePartsFormat : String 确定调用在输出消息中定义多个部分的 Web 服务的默认结果对象的类型。	Operation
		name : String 此操作的名称。	AbstractOperation
		operationManager : Function 此属性通常由框架代码设置，框架代码需要修改服务调用的行为，而不修改外部调用服务的方式。	AbstractInvoker
		properties : Object 这是一个挂钩，主要供框架开发人员用来为您的操作注册用户指定的其它属性。	AbstractOperation
		request : Object 该 Operation 的请求是对象结构或 XML 结构。	Operation
		resultElementType : Class 与 resultType 类似，用于定义由给定操作使用的 ActionScript 类，但是此属性只适用于返回多值结果（例如，Array 或 ArrayCollection (IList)）的操作。	AbstractInvoker
		resultFormat : String 确定如何解码 Operation 结果。	Operation
		resultHeaders : Array [只读] 上次执行此操作过程中返回的标头。	Operation
		resultType : Class 指定操作的可选返回类型。	AbstractInvoker
		service : AbstractService [只读] 提供对在其上调用此操作的服务的方便访问。	AbstractOperation
		xmlSpecialCharsFilter : Function 指定用于在对任何简单内容编码之前转义 XML 特殊字符的自定义函数。	Operation

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		Operation(webService:AbstractService = null, name:String = null) 创建一个新的 Operation。	Operation
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		addHeader(header:Object):void 添加仅应用于此 Operation 的标头。	Operation
		addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void 添加仅应用于此 Operation 的标头。	Operation
		cancel(id:String = null):mx.rpc:AsyncToken [覆盖] 取消上次服务调用或具有指定 ID 的调用。	Operation
		clearHeaders():void 清除此单个 Operation 的标头。	Operation
		clearResult(fireBindingEvent:Boolean = true):void 将 invoker 的 result 属性设置为 null。	AbstractInvoker
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		getHeader(qname:QName, headerName:String = null):SOAPHeader 如果根据 QName localName 和 URI 找到匹配标头，则返回该标头。	Operation
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		removeHeader(qname:QName, headerName:String = null):void 从所有操作中删除具有给定 QName 的标头。	Operation
		send(... args):mx.rpc:AsyncToken 执行此方法。	AbstractOperation
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setResult(result:Object):void 公开此挂钩可以更新 lastResult 属性。	AbstractInvoker
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
fault	当操作调用失败时调度。	AbstractOperation
header	当 Operation 调用返回响应结果中的 SOAP 标头时调度。	Operation
result	当操作调用成功返回时调度。	AbstractOperation

属性详细信息

endpointURI

属性

endpointURI:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

此 Operation 的 WebService 位置。通常，WSDL 指定服务的位置，但可设置此属性来覆盖该单个 Operation 的位置。

实现
public function get endpointURI():String
public function set endpointURI(value:String):void

forcePartArrays

属性

forcePartArrays:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定定义为数组的输出消息部分的单个返回值或空返回值是否应作为包含一个或零个元素的数组返回。这适用于文档/文本“wrapped”Web 服务，在采用此方式的服务中，表示“wrapper”序列中各消息部分的一个或多个元素可将 maxOccurs 属性设置为大于 1 的值。这表示：即使响应包含该部分的零个或一个值，相应部分也应被视为一个数组。将 forcePartArrays 设置为 true 将始终为以此方式定义的各部分创建数组，无论返回的值数是多少都是如此。如果将 forcePartArrays 保留为 false，则仅在返回两个或多个元素时才创建数组。

实现
public function get forcePartArrays():Boolean
public function set forcePartArrays(value:Boolean):void

headerFormat

属性

headerFormat:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定如何解码 SOAP 编码的标头。值 object 指定将每个标头 XML 节点解码为一个 SOAPHeader 对象，并且其 content 属性采用在 WSDL 文档中指定的对象结构。值 xml 指定 XML 将保留为 XMLNodes。值 e4x 指定将可使用 ECMAScript for XML (E4X) 表达式访问该 XML。

实现
public function get headerFormat():String
public function set headerFormat(value:String):void

headers

属性

headers:Array [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

要在每次调用操作时发送的 SOAPHeaders 数组的存取器。

实现
public function get headers():Array

httpHeaders

属性

httpHeaders:Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

发送到 SOAP 端点的自定义 HTTP 标头。如果需要以相同名称发送多个标头，应将值指定为一个数组。

实现
public function get httpHeaders():Object
public function set httpHeaders(value:Object):void

ignoreWhitespace

属性

ignoreWhitespace:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定为 SOAP 编码的请求或响应处理 XML 时是否忽略空格。默认值为 true，即不保留空格。如果 XML Schema 类型定义指定将 whiteSpace 限制设置为 preserve，则必须先将 ignoreWhitespace 设置为 false。相反，如果将 whiteSpace 类型限制设置为 replace 或 collapse，则即使 ignoreWhitespace 设置为 false 也保留该设置。

实现
public function get ignoreWhitespace():Boolean
public function set ignoreWhitespace(value:Boolean):void

makeObjectsBindable

属性

makeObjectsBindable:Boolean[覆盖]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

当该置为 true 时，返回的匿名对象将强制成为可绑定的对象。

实现
override public function get makeObjectsBindable():Boolean
override public function set makeObjectsBindable(value:Boolean):void

multiplePartsFormat

属性

multiplePartsFormat:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定调用在输出消息中定义多个部分的 Web 服务的默认结果对象的类型。值“object”指定 lastResult 对象将是具有与各输出部分对应命名属性的 Object。值“array”将使 lastResult 成为一个数组，各部分值按照在 SOAP 消息体中出现的顺序进入数组。文档文本操作的默认值为“object”。RPC 操作的默认值为“array”。仅当 resultFormat 为“object”时 multiplePartsFormat 属性才可用，否则将忽略。

实现
public function get multiplePartsFormat():String
public function set multiplePartsFormat(value:String):void

request

属性

request:Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

该 Operation 的请求是对象结构或 XML 结构。如果指定 XML，则 XML 按原样发送。如果传递一个对象，则该对象将被编码为 SOAP XML 结构。

实现
public function get request():Object
public function set request(value:Object):void

resultFormat

属性

resultFormat:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定如何解码 Operation 结果。值 object 指定将 XML 解码为 WSDL 文档中所指定的对象结构。值 xml 指定 XML 将保留为 XMLNodes。值 e4x 指定将可使用 ECMAScript for XML (E4X) 表达式访问该 XML。

实现
public function get resultFormat():String
public function set resultFormat(value:String):void

resultHeaders

属性

resultHeaders:Array [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

上次执行此操作过程中返回的标头。它们与 lastResult 属性相匹配并且与作为 HeaderEvents 单独调度的标头集合相同。

此属性可用作数据绑定的源。修改此属性后，将调度 resultForBinding 事件。

实现
public function get resultHeaders():Array

xmlSpecialCharsFilter

属性

xmlSpecialCharsFilter:Function

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

指定用于在对任何简单内容编码之前转义 XML 特殊字符的自定义函数。除非专门在操作级上进行了覆盖，否则对 Web 服务上的所有操作有效。如果未提供函数，则默认为由 IXMLEncoder 的特定实现设置的相应内容。

实现
public function get xmlSpecialCharsFilter():Function
public function set xmlSpecialCharsFilter(value:Function):void

构造函数详细信息

()

构造函数

public function Operation(webService:AbstractService = null, name:String = null)

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

创建一个新的 Operation。当访问未知操作时，该操作通常直接由 MXML 编译器完成或由 WebService 自动完成。建议开发人员不要直接使用此构造函数。

参数

	`webService:AbstractService` (default = `null`) — 对其调用此 Operation 的 Web 服务。

	`name:String` (default = `null`) — 此操作的名称。

方法详细信息

addHeader

()

方法

public function addHeader(header:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

添加仅应用于此 Operation 的标头。标头可以以预编码形式提供，可以作为 XML 实例，也可以作为 SOAPHeader 实例（将编码留给内部 SOAP 编码器处理）。

参数

header:Object — 要添加到此 Operation 的 SOAP 标头。

addSimpleHeader

()

方法

public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

添加仅应用于此 Operation 的标头。

参数

	`qnameLocal:String` — 标头 QName 的 localname

	`qnameNamespace:String` — 标头 QName 的命名空间

	`headerName:String` — 标头的名称。

	`headerValue:String` — 标头的值。

cancel

()

方法

override public function cancel(id:String = null):mx.rpc:AsyncToken

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

取消上次服务调用或具有指定 ID 的调用。即使网络操作可能仍在继续，也不调度 result 或 fault 事件。

参数

id:String (default = null) — 要取消的调用的 messageId。可选。如果省略，将取消上一次服务调用。

mx.rpc:AsyncToken — 与被取消的调用关联的 AsyncToken，如果未取消任何调用，则为 null。

clearHeaders

()

方法

public function clearHeaders():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

清除此单个 Operation 的标头。

getHeader

()

方法

public function getHeader(qname:QName, headerName:String = null):SOAPHeader

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果根据 QName localName 和 URI 找到匹配标头，则返回该标头。

参数

	`qname:QName` — SOAPHeader 的 QName。

	`headerName:String` (default = `null`) — SOAPHeader 内容中的标头名称（可选）

SOAPHeader — 返回 SOAPHeader。

removeHeader

()

方法

public function removeHeader(qname:QName, headerName:String = null):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从所有操作中删除具有给定 QName 的标头。

参数

	`qname:QName` — SOAPHeader 的 QName。

	`headerName:String` (default = `null`) — SOAPHeader 内容中的标头名称（可选）

事件详细信息

header

事件

事件对象类型: mx.rpc.events.HeaderEvent
属性 HeaderEvent.type = mx.rpc.events.HeaderEvent.HEADER

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

当 Operation 调用返回响应结果中的 SOAP 标头时调度。为每个 SOAP 标头调用 HeaderEvent。

HEADER 事件类型。

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

属性	值
`bubbles`	false
`token`	表示方法调用的标记。用于异步完成标记模式。
`cancelable`	true，但 preventDefault() 方法无效。
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`header`	RPC 调用在响应中返回的标头。
`message`	与此事件相关联的 Message。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。

法律声明 | 在线隐私策略

Operation - AS3 Flex

包x

语言元素

附录

包 mx.rpc.soap

endpointURI

forcePartArrays

headerFormat

headers

httpHeaders

ignoreWhitespace

makeObjectsBindable

multiplePartsFormat

request

resultFormat

resultHeaders

xmlSpecialCharsFilter

Operation

addHeader

addSimpleHeader

cancel

clearHeaders

getHeader

removeHeader

header