SPMobileMessageDeliveryReportItem Class

Represents an error or success item for a delivery report from a Web service that uses the Office Mobile Service (OMS) protocol.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.MobileMessage.SPMobileMessageDeliveryReportItem

Namespace:  Microsoft.SharePoint.MobileMessage
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Class SPMobileMessageDeliveryReportItem
'Usage
Dim instance As SPMobileMessageDeliveryReportItem
public class SPMobileMessageDeliveryReportItem

Remarks

An SPMobileMessageDeliveryReportItem is an object oriented version of an OMS error element within an xmsResponse element that is sent by the Web service in response to a call of its DeliverXms method, the main OMS method for sending a message to a mobile device. Despite its name, an error element can report either success or an error. Hence, the SPMobileMessageDeliveryReportItem.DeliveryCode property can be Succeeded.

Note

The SPMobileMessageDeliveryReport class represents the xmsResponse element, so its Items property is a collection of SPMobileMessageDeliveryReportItem objects.

For more information about OMS, see the series of articles beginning with Outlook 2007 Mobile Service Guidelines (Part 1 of 3).

Examples

The following shows an example of an xmsResponse for a message that was successfully sent with its child error element. Note that the code attribute value of “ok” is represented in the SPMobileMessageDeliveryReportItem object as a DeliveryCode property value of Succeeded.

<?xml version="1.0" encoding="utf-8"?>
<xmsResponse xmlns="https://schemas.microsoft.com/office/Outlook/2006/OMS">
   <error code="ok" severity="neutral"/> 
</xmsResponse>

The following shows an example of an xmsResponse for a message attempt that failed sent with its child error element. Note that the content and recipientList elements are represented in the SPMobileMessageDeliveryReportItem object by its Content and RecipientList properties, respectively. The code attribute value of “perDayMsgLimit” is represented in the SPMobileMessageDeliveryReportItem object as a DeliveryCode property value of PerDayMessageLimit.

<?xml version="1.0" encoding="utf-8"?>
<xmsResponse xmlns="https://schemas.microsoft.com/office/Outlook/2006/OMS">
   <error code="perDayMsgLimit" severity="failure">
      <content>20 SMS</content>
      <recipientList>13601391354;13601391388</recipientList>
   </error> 
</xmsResponse>

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

SPMobileMessageDeliveryReportItem Members

Microsoft.SharePoint.MobileMessage Namespace