Public Member Functions | Properties

SQSReceiveMessageRequest Class Reference

Receive Message Request. More...

#import <SQSReceiveMessageRequest.h>

List of all members.

Public Member Functions

(id) - init
 Default constructor for a new ReceiveMessageRequest object.
(id) - initWithQueueUrl:
 Constructs a new ReceiveMessageRequest object.
(NSString *) - description
 Returns a string representation of this object; useful for testing and debugging.

Properties

NSString * queueUrl
NSMutableArray * attributeNames
 A list of attributes to get.
NSNumber * maxNumberOfMessages
 The maximum number of messages to return.
NSNumber * visibilityTimeout
 The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

Detailed Description

Receive Message Request.


Member Function Documentation

- (NSString* SQSReceiveMessageRequest.)description  

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

Returns:
A string representation of this object.
- (id SQSReceiveMessageRequest.)init  

Default constructor for a new ReceiveMessageRequest object.

Callers should use the property methods to initialize this object after creating it.

- (id SQSReceiveMessageRequest.)initWithQueueUrl: (NSString *)  theQueueUrl  

Constructs a new ReceiveMessageRequest object.

Callers should use properties to initialize any additional object members.

Parameters:
theQueueUrl 

Property Documentation

- (NSNumber *) maxNumberOfMessages [read, write, retain]

The maximum number of messages to return.

Amazon SQS never returns more messages than this value but may return fewer.

All of the messages are not necessarily returned.


The documentation for this class was generated from the following file: