AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
A list of received messages.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SQS.Model.ReceiveMessageResult

Namespace: Amazon.SQS.Model
Assembly: AWSSDK.dll
Version: 0.0.3.0

Syntax

C#
public class ReceiveMessageResult : AmazonWebServiceResponse

The ReceiveMessageResult type exposes the following members

Constructors

  Name Description
Public Method ReceiveMessageResult()

Properties

  Name Description
Public Property ContentLength Returns the content length of the HTTP response.
Public Property HttpStatusCode Returns the status code of the HTTP response.
Public Property Messages Gets and sets the property Messages.

A list of messages.

Public Property ResponseMetadata Contains additional information about the request, such as the Request Id.

Examples

This example shows how to receive a message.

Receive message example

var client = new AmazonSQSClient();

var request = new ReceiveMessageRequest
{
  AttributeNames = new List<string>() { "All" },
  MaxNumberOfMessages = 5,
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue",
  VisibilityTimeout = (int)TimeSpan.FromMinutes(10).TotalSeconds,
  WaitTimeSeconds = (int)TimeSpan.FromSeconds(5).TotalSeconds
};

var response = client.ReceiveMessage(request);

if (response.Messages.Count > 0)
{
  foreach (var message in response.Messages)
  {
    Console.WriteLine("For message ID '" + message.MessageId + "':");
    Console.WriteLine("  Body: " + message.Body);
    Console.WriteLine("  Receipt handle: " + message.ReceiptHandle);
    Console.WriteLine("  MD5 of body: " + message.MD5OfBody);
    Console.WriteLine("  MD5 of message attributes: " +
      message.MD5OfMessageAttributes);
    Console.WriteLine("  Attributes:");

    foreach (var attr in message.Attributes)
    {
      Console.WriteLine("    " + attr.Key + ": " + attr.Value);
    }
  }
}
else
{
  Console.WriteLine("No messages received.");
}
      

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8