CloudQueueMessage (Microsoft Windows Azure Client API 0.4.6 API)

java.lang.Object
- com.microsoft.windowsazure.services.queue.client.CloudQueueMessage

```
public class CloudQueueMessage
extends Object
```
Represents a message in the Windows Azure Queue service.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`dequeueCount` Holds the dequeue count.
`protected Date`	`expirationTime` Holds the time that the message expires.
`protected String`	`id` Holds the message ID.
`protected Date`	`insertionTime` Holds the time that the message was added to the queue.
`protected String`	`messageContent` Holds the message content.
`protected QueueMessageType`	`messageType` Holds the message type.
`protected Date`	`nextVisibleTime` Holds the time that the message will next be visible.
`protected String`	`popReceipt` Holds the message's pop receipt.

Constructor Summary

Constructors
Constructor and Description
`CloudQueueMessage(byte[] content)` Initializes a new instance of the CloudQueueMessage class with an array of `byte` containing the message.
`CloudQueueMessage(String content)` Initializes a new instance of the CloudQueueMessage class with a string containing the message.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getDequeueCount()` Gets the dequeue count.
`Date`	`getExpirationTime()` Gets the time that the message expires.
`String`	`getId()` Gets the message ID.
`Date`	`getInsertionTime()` Gets the time that the message was added to the queue.
`byte[]`	`getMessageContentAsByte()` Gets the content of the message as a byte array.
`String`	`getMessageContentAsString()` Gets the content of the message as a string.
`protected String`	`getMessageContentForTransfer(boolean shouldEncodeMessage)` Gets the content of the message for transfer (internal use only).
`Date`	`getNextVisibleTime()` Gets the time that the message will next be visible.
`String`	`getPopReceipt()` Gets the message's pop receipt.
`void`	`setExpirationTime(Date expirationTime)` Sets the expiration time for the message.
`void`	`setMessageContent(byte[] content)` Sets the content of the message as an array of `byte`.
`void`	`setMessageContent(String content)` Sets the content of the message as a `String`.
`void`	`setNextVisibleTime(Date nextVisibleTime)` Sets the time for the message to become visible in the queue.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
    Holds the message ID.
  - popReceipt
```
protected String popReceipt
```
    Holds the message's pop receipt.
  - insertionTime
```
protected Date insertionTime
```
    Holds the time that the message was added to the queue.
  - expirationTime
```
protected Date expirationTime
```
    Holds the time that the message expires.
  - nextVisibleTime
```
protected Date nextVisibleTime
```
    Holds the time that the message will next be visible.
  - messageContent
```
protected String messageContent
```
    Holds the message content.
  - dequeueCount
```
protected int dequeueCount
```
    Holds the dequeue count.
  - messageType
```
protected QueueMessageType messageType
```
    Holds the message type.
- Constructor Detail
  - CloudQueueMessage
```
public CloudQueueMessage(byte[] content)
```
    Initializes a new instance of the CloudQueueMessage class with an array of byte containing the message.
    
    Parameters:
    content - The array of byte that contains the message.
  - CloudQueueMessage
```
public CloudQueueMessage(String content)
```
    Initializes a new instance of the CloudQueueMessage class with a string containing the message.
    
    Parameters:
    content - The String that contains the message.
- Method Detail
  - getDequeueCount
```
public final int getDequeueCount()
```
    Gets the dequeue count.
    
    Returns:
    The dequeue count.
  - getExpirationTime
```
public final Date getExpirationTime()
```
    Gets the time that the message expires.
    
    Returns:
    The time that the message expires.
  - getId
```
public final String getId()
```
    Gets the message ID.
    
    Returns:
    A String that contains the message ID.
  - getInsertionTime
```
public final Date getInsertionTime()
```
    Gets the time that the message was added to the queue.
    
    Returns:
    The time that the message was added to the queue.
  - getMessageContentAsByte
```
public final byte[] getMessageContentAsByte()
                                     throws StorageException
```
    Gets the content of the message as a byte array.
    
    Returns:
    An array of byte with the content of the message.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - getMessageContentAsString
```
public final String getMessageContentAsString()
                                       throws StorageException
```
    Gets the content of the message as a string.
    
    Returns:
    A String with the content of the message.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - getMessageContentForTransfer
```
protected final String getMessageContentForTransfer(boolean shouldEncodeMessage)
                                             throws StorageException
```
    Gets the content of the message for transfer (internal use only).
    
    Returns:
    A String with the content of the message.
    
    Throws:
    
    StorageException
  - getNextVisibleTime
```
public final Date getNextVisibleTime()
```
    Gets the time that the message will next be visible.
    
    Returns:
    A java.util.Date with the time that the message will next be visible.
  - getPopReceipt
```
public final String getPopReceipt()
```
    Gets the message's pop receipt.
    
    Returns:
    A String containing the message's pop receipt.
  - setExpirationTime
```
public final void setExpirationTime(Date expirationTime)
```
    Sets the expiration time for the message.
    
    Parameters:
    expirationTime - The java.util.Date representing the expiration time to set on the message.
  - setMessageContent
```
public final void setMessageContent(byte[] content)
```
    Sets the content of the message as an array of byte.
    
    Parameters:
    content - The content of the message.
  - setMessageContent
```
public final void setMessageContent(String content)
```
    Sets the content of the message as a String.
    
    Parameters:
    content - The content of the message.
  - setNextVisibleTime
```
public final void setNextVisibleTime(Date nextVisibleTime)
```
    Sets the time for the message to become visible in the queue.
    
    Parameters:
    nextVisibleTime - The java.util.Date representing the time to set for the message to be visible.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class CloudQueueMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

popReceipt

insertionTime

expirationTime

nextVisibleTime

messageContent

dequeueCount

messageType

Constructor Detail

CloudQueueMessage

CloudQueueMessage

Method Detail

getDequeueCount

getExpirationTime

getId

getInsertionTime

getMessageContentAsByte

getMessageContentAsString

getMessageContentForTransfer

getNextVisibleTime

getPopReceipt

setExpirationTime

setMessageContent

setMessageContent

setNextVisibleTime