FeedbackBatch.xml

<Type Name="FeedbackBatch" FullName="Microsoft.Azure.Devices.FeedbackBatch">
  <TypeSignature Language="C#" Value="public class FeedbackBatch" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FeedbackBatch extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.FeedbackBatch" />
  <TypeSignature Language="VB.NET" Value="Public Class FeedbackBatch" />
  <TypeSignature Language="F#" Value="type FeedbackBatch = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
    <AssemblyVersion>1.31.0.0</AssemblyVersion>
    <AssemblyVersion>1.32.0.0</AssemblyVersion>
    <AssemblyVersion>1.33.0.0</AssemblyVersion>
    <AssemblyVersion>1.34.0.0</AssemblyVersion>
    <AssemblyVersion>1.35.0.0</AssemblyVersion>
    <AssemblyVersion>1.36.0.0</AssemblyVersion>
    <AssemblyVersion>1.37.0.0</AssemblyVersion>
    <AssemblyVersion>1.37.1.0</AssemblyVersion>
    <AssemblyVersion>1.38.0.0</AssemblyVersion>
    <AssemblyVersion>1.38.1.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Contains a batch of feedback records.
            </summary>
    <remarks>
            Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FeedbackBatch ();" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.FeedbackBatch.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="C#" Value="protected internal FeedbackBatch ();" FrameworkAlternate="azure-dotnet-preview" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor() cil managed" FrameworkAlternate="azure-dotnet-preview" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Sub New ()" FrameworkAlternate="azure-dotnet-preview" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>1.38.1.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            This constructor is for deserialization and unit test mocking purposes.
            </summary>
        <remarks>
            To unit test methods that use this type as a response, inherit from this class and give it a constructor
            that can set the properties you want.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="EnqueuedOnUtc">
      <MemberSignature Language="C#" Value="public DateTimeOffset EnqueuedOnUtc { get; protected internal set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset EnqueuedOnUtc" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackBatch.EnqueuedOnUtc" />
      <MemberSignature Language="VB.NET" Value="Public Property EnqueuedOnUtc As DateTimeOffset" />
      <MemberSignature Language="F#" Value="member this.EnqueuedOnUtc : DateTimeOffset with get, set" Usage="Microsoft.Azure.Devices.FeedbackBatch.EnqueuedOnUtc" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTimeOffset</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            When the feedback message was received by the IoT hub in UTC.
            </summary>
        <value>To be added.</value>
        <remarks>
            Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="EnqueuedTime">
      <MemberSignature Language="C#" Value="public DateTime EnqueuedTime { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime EnqueuedTime" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackBatch.EnqueuedTime" />
      <MemberSignature Language="VB.NET" Value="Public Property EnqueuedTime As DateTime" />
      <MemberSignature Language="F#" Value="member this.EnqueuedTime : DateTime with get, set" Usage="Microsoft.Azure.Devices.FeedbackBatch.EnqueuedTime" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>1.38.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTime</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Date and time that indicates when the feedback message was received by the IoT hub.
            Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IotHubHostName">
      <MemberSignature Language="C#" Value="public string IotHubHostName { get; protected internal set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string IotHubHostName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackBatch.IotHubHostName" />
      <MemberSignature Language="VB.NET" Value="Public Property IotHubHostName As String" />
      <MemberSignature Language="F#" Value="member this.IotHubHostName : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackBatch.IotHubHostName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The IoT hub host name.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Records">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Devices.FeedbackRecord&gt; Records { get; set; }" FrameworkAlternate="azure-dotnet" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;class Microsoft.Azure.Devices.FeedbackRecord&gt; Records" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackBatch.Records" />
      <MemberSignature Language="VB.NET" Value="Public Property Records As IEnumerable(Of FeedbackRecord)" />
      <MemberSignature Language="F#" Value="member this.Records : seq&lt;Microsoft.Azure.Devices.FeedbackRecord&gt; with get, set" Usage="Microsoft.Azure.Devices.FeedbackBatch.Records" />
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Devices.FeedbackRecord&gt; Records { get; protected internal set; }" FrameworkAlternate="azure-dotnet-preview" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>1.38.1.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IEnumerable&lt;Microsoft.Azure.Devices.FeedbackRecord&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A collection of feedback records of C2D messages across multiple devices in the IoT hub.
            </summary>
        <value>To be added.</value>
        <remarks>
            Feedback messages are delivery acknowledgments for messages sent to a device from IoT hub.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="UserId">
      <MemberSignature Language="C#" Value="public string UserId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string UserId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.FeedbackBatch.UserId" />
      <MemberSignature Language="VB.NET" Value="Public Property UserId As String" />
      <MemberSignature Language="F#" Value="member this.UserId : string with get, set" Usage="Microsoft.Azure.Devices.FeedbackBatch.UserId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>1.38.1.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The IoT hub hostname.
            </summary>
        <value>To be added.</value>
        <remarks>
            Despite the name of this member, the value will be the IoT hub hostname.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>