Packagecom.amazonaws.services.sqs.model
Classpublic class ReceiveMessageResult
InheritanceReceiveMessageResult Inheritance AmazonWebServiceResult Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Since : February 1. 2011
Runtime Versions : Flash Player 10.1, AIR 2.5

Container for the 'ReceiveMessage operation' response parameters.



Public Properties
 PropertyDefined By
 InheritedrawData : Object
Gets received raw data (XML format).
AmazonWebServiceResult
Public Methods
 MethodDefined By
  
ReceiveMessageResult
  
getMessages():Array
A list of messages.
ReceiveMessageResult
 Inherited
getRequestId():String
The AWS request ID that uniquely identifies the service request the caller made.
AmazonWebServiceResult
  
parse(data:Object = null):ResponseResult
[override] Returns parsed XML data from AWS response.
ReceiveMessageResult
  
setMessages(messages:Array):void
A list of messages.
ReceiveMessageResult
 Inherited
setRequestId(requestId:String):void
The AWS request ID that uniquely identifies the service request the caller made.
AmazonWebServiceResult
  
toString():String
[override] Returns a string representation of this object; useful for testing and debugging.
ReceiveMessageResult
  
A list of messages.
ReceiveMessageResult
 Inherited
withRawData(rawData:Object):ResponseResult
Sets new raw data.
AmazonWebServiceResult
 Inherited
withRequestId(requestId:String):ResponseResult
The AWS request ID that uniquely identifies the service request the caller made.
AmazonWebServiceResult
Constructor Detail
ReceiveMessageResult()Constructor
public function ReceiveMessageResult()

Method Detail
getMessages()method
public function getMessages():Array

A list of messages.

Returns
Array — A list of messages.
parse()method 
override public final function parse(data:Object = null):ResponseResult

Returns parsed XML data from AWS response.

Parameters

data:Object (default = null) — data raw data to be parsed

Returns
ResponseResult — A reference to this updated object so that method calls can be chained together.

Throws
SyntaxError — if AWS namespace not available in XML response
setMessages()method 
public function setMessages(messages:Array):void

A list of messages.

Parameters

messages:Array — A list of messages.

IMPORTANT: List must contain com.amazonaws.services.sqs.model.Message instances

See also

toString()method 
override public function toString():String

Returns a string representation of this object; useful for testing and debugging.

Returns
String — A string representation of this object.
withMessages()method 
public function withMessages(messages:Array):ReceiveMessageResult

A list of messages. Returns a reference to this object so that method calls can be chained together.

Parameters

messages:Array — A list of messages.

IMPORTANT: List must contain com.amazonaws.services.sqs.model.Message instances

Returns
ReceiveMessageResult — A reference to this updated object so that method calls can be chained together.

See also