WAQueueMessage Class Reference
Inherits from | NSObject |
Declared in | WAQueueMessage.h |
Tasks
-
messageId
The identifier for the message in the queue.
property -
insertionTime
The time the message was inserted into the queue.
property -
expirationTime
The expieration time for the message in the queue.
property -
popReceipt
The message’s pop receipt. The pop receipt is an opaque value that indicates that the message has been retrieved and can be used to delete it.
property -
timeNextVisible
The time that the message will next be visible. The property is updated when a message is retrieved from the queue. It indicates when a message will become visible again to other clients, if it is not first deleted by the client that retrieved it.
property -
messageText
The message text.
property -
dequeueCount
The number of times this message has been dequeued.
property -
– initQueueMessageWithMessageId:insertionTime:expirationTime:popReceipt:timeNextVisible:messageText:
Initializes a newly created WAQueueMessage with an identifier, insertion time, experiation time, pop receipt, next visible time and message text.
-
– initQueueMessageWithMessageId:insertionTime:expirationTime:popReceipt:timeNextVisible:messageText:dequeueCount:
Initializes a newly created WAQueueMessage with an identifier, insertion time, experiation time, pop receipt, next visible time and message text.
Properties
dequeueCount
The number of times this message has been dequeued.
@property (readonly) NSInteger dequeueCount
Declared In
WAQueueMessage.h
expirationTime
The expieration time for the message in the queue.
@property (readonly) NSString *expirationTime
Declared In
WAQueueMessage.h
insertionTime
The time the message was inserted into the queue.
@property (readonly) NSString *insertionTime
Declared In
WAQueueMessage.h
messageId
The identifier for the message in the queue.
@property (readonly) NSString *messageId
Declared In
WAQueueMessage.h
popReceipt
The message’s pop receipt. The pop receipt is an opaque value that indicates that the message has been retrieved and can be used to delete it.
@property (readonly) NSString *popReceipt
Declared In
WAQueueMessage.h
timeNextVisible
The time that the message will next be visible. The property is updated when a message is retrieved from the queue. It indicates when a message will become visible again to other clients, if it is not first deleted by the client that retrieved it.
@property (readonly) NSString *timeNextVisible
Declared In
WAQueueMessage.h
Instance Methods
initQueueMessageWithMessageId:insertionTime:expirationTime:popReceipt:timeNextVisible:messageText:
Initializes a newly created WAQueueMessage with an identifier, insertion time, experiation time, pop receipt, next visible time and message text.
- (id)initQueueMessageWithMessageId:(NSString *)messageId insertionTime:(NSString *)insertionTime expirationTime:(NSString *)expirationTime popReceipt:(NSString *)popReceipt timeNextVisible:(NSString *)timeNextVisible messageText:(NSString *)messageText
Parameters
- messageId
The message identifier.
- insertionTime
The insertion time for the message.
- expirationTime
The expiration time for the message.
- popReceipt
the pop receipt for the message.
- timeNextVisible
The next visible time for the message.
- messageText
The message text.
Return Value
The newly initialized WAQueueMessage object.
Declared In
WAQueueMessage.h
initQueueMessageWithMessageId:insertionTime:expirationTime:popReceipt:timeNextVisible:messageText:dequeueCount:
Initializes a newly created WAQueueMessage with an identifier, insertion time, experiation time, pop receipt, next visible time and message text.
- (id)initQueueMessageWithMessageId:(NSString *)messageId insertionTime:(NSString *)insertionTime expirationTime:(NSString *)expirationTime popReceipt:(NSString *)popReceipt timeNextVisible:(NSString *)timeNextVisible messageText:(NSString *)messageText dequeueCount:(NSInteger)dequeueCount
Parameters
- messageId
The message identifier.
- insertionTime
The insertion time for the message.
- expirationTime
The expiration time for the message.
- popReceipt
the pop receipt for the message.
- timeNextVisible
The next visible time for the message.
- messageText
The message text.
- dequeueCount
The dequeue count.
Return Value
The newly initialized WAQueueMessage object.
Declared In
WAQueueMessage.h