ClientTwinProperties.xml

<Type Name="ClientTwinProperties" FullName="Microsoft.Azure.Devices.ClientTwinProperties">
  <TypeSignature Language="C#" Value="public class ClientTwinProperties : System.Collections.IEnumerable" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientTwinProperties extends System.Object implements class System.Collections.IEnumerable" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.ClientTwinProperties" />
  <TypeSignature Language="VB.NET" Value="Public Class ClientTwinProperties&#xA;Implements IEnumerable" />
  <TypeSignature Language="F#" Value="type ClientTwinProperties = class&#xA;    interface IEnumerable" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Collections.IEnumerable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinPropertiesJsonConverter))]</AttributeName>
      <AttributeName Language="F#">[&lt;Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Devices.ClientTwinPropertiesJsonConverter))&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Represents a collection of properties for the twin.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientTwinProperties ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Creates an instance of this class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientTwinProperties (string twinJson);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string twinJson) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (twinJson As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ClientTwinProperties : string -&gt; Microsoft.Azure.Devices.ClientTwinProperties" Usage="new Microsoft.Azure.Devices.ClientTwinProperties twinJson" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="twinJson" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="twinJson">JSON fragment containing the twin data.</param>
        <summary>
            Creates an instance of this class using a JSON fragment as the body.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientTwinProperties (Newtonsoft.Json.Linq.JObject twinJson, Newtonsoft.Json.Linq.JObject metadataJson);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Newtonsoft.Json.Linq.JObject twinJson, class Newtonsoft.Json.Linq.JObject metadataJson) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.#ctor(Newtonsoft.Json.Linq.JObject,Newtonsoft.Json.Linq.JObject)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (twinJson As JObject, metadataJson As JObject)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ClientTwinProperties : Newtonsoft.Json.Linq.JObject * Newtonsoft.Json.Linq.JObject -&gt; Microsoft.Azure.Devices.ClientTwinProperties" Usage="new Microsoft.Azure.Devices.ClientTwinProperties (twinJson, metadataJson)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="twinJson" Type="Newtonsoft.Json.Linq.JObject" />
        <Parameter Name="metadataJson" Type="Newtonsoft.Json.Linq.JObject" />
      </Parameters>
      <Docs>
        <param name="twinJson">JSON fragment containing the twin data.</param>
        <param name="metadataJson">JSON fragment containing the metadata.</param>
        <summary>
            Creates an instance of this class using the given JSON fragments for the body and metadata.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientTwinProperties (string twinJson, string metadataJson);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string twinJson, string metadataJson) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (twinJson As String, metadataJson As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ClientTwinProperties : string * string -&gt; Microsoft.Azure.Devices.ClientTwinProperties" Usage="new Microsoft.Azure.Devices.ClientTwinProperties (twinJson, metadataJson)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="twinJson" Type="System.String" />
        <Parameter Name="metadataJson" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="twinJson">JSON fragment containing the twin data.</param>
        <param name="metadataJson">JSON fragment containing the metadata.</param>
        <summary>
            Creates an instance of this class using the given JSON fragments for the body and metadata.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ClearMetadata">
      <MemberSignature Language="C#" Value="public void ClearMetadata ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ClearMetadata() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.ClearMetadata" />
      <MemberSignature Language="VB.NET" Value="Public Sub ClearMetadata ()" />
      <MemberSignature Language="F#" Value="member this.ClearMetadata : unit -&gt; unit" Usage="clientTwinProperties.ClearMetadata " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Clears all metadata out of the twin collection as well as the base metadata object.
            </summary>
        <remarks>
            This will remove all metadata from the base metadata object as well as the metadata for the twin collection. 
            This will also clear the underlying metadata object which will affect methods such as
            <see cref="M:Microsoft.Azure.Devices.ClientTwinProperties.GetMetadata" /> and <see cref="M:Microsoft.Azure.Devices.ClientTwinProperties.GetLastUpdatedVersion" />.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Contains">
      <MemberSignature Language="C#" Value="public bool Contains (string propertyName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(string propertyName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.Contains(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function Contains (propertyName As String) As Boolean" />
      <MemberSignature Language="F#" Value="member this.Contains : string -&gt; bool" Usage="clientTwinProperties.Contains propertyName" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="propertyName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="propertyName">The property to locate.</param>
        <summary>
            Determines whether the specified property is present.
            </summary>
        <returns>true if the specified property is present; otherwise, false.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Count">
      <MemberSignature Language="C#" Value="public int Count { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwinProperties.Count" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Count As Integer" />
      <MemberSignature Language="F#" Value="member this.Count : int" Usage="Microsoft.Azure.Devices.ClientTwinProperties.Count" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the count of properties in the collection.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetEnumerator">
      <MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.IEnumerator GetEnumerator() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.GetEnumerator" />
      <MemberSignature Language="VB.NET" Value="Public Iterator Overridable NotOverridable Function GetEnumerator () As IEnumerator" />
      <MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -&gt; System.Collections.IEnumerator&#xA;override this.GetEnumerator : unit -&gt; System.Collections.IEnumerator" Usage="clientTwinProperties.GetEnumerator " />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.IteratorStateMachine(typeof(Microsoft.Azure.Devices.ClientTwinProperties+&lt;GetEnumerator&gt;d__27))]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.IteratorStateMachine(typeof(Microsoft.Azure.Devices.ClientTwinProperties+&lt;GetEnumerator&gt;d__27))&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="GetLastUpdatedOnUtc">
      <MemberSignature Language="C#" Value="public DateTimeOffset GetLastUpdatedOnUtc ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.DateTimeOffset GetLastUpdatedOnUtc() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.GetLastUpdatedOnUtc" />
      <MemberSignature Language="VB.NET" Value="Public Function GetLastUpdatedOnUtc () As DateTimeOffset" />
      <MemberSignature Language="F#" Value="member this.GetLastUpdatedOnUtc : unit -&gt; DateTimeOffset" Usage="clientTwinProperties.GetLastUpdatedOnUtc " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.DateTimeOffset</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Gets the last time this property was updated in UTC.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetLastUpdatedVersion">
      <MemberSignature Language="C#" Value="public long? GetLastUpdatedVersion ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Nullable`1&lt;int64&gt; GetLastUpdatedVersion() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.GetLastUpdatedVersion" />
      <MemberSignature Language="VB.NET" Value="Public Function GetLastUpdatedVersion () As Nullable(Of Long)" />
      <MemberSignature Language="F#" Value="member this.GetLastUpdatedVersion : unit -&gt; Nullable&lt;int64&gt;" Usage="clientTwinProperties.GetLastUpdatedVersion " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Gets the last updated version for this property.
            </summary>
        <returns>Last updated version if present, null otherwise.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetMetadata">
      <MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.ClientTwinMetadata GetMetadata ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Devices.ClientTwinMetadata GetMetadata() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.GetMetadata" />
      <MemberSignature Language="VB.NET" Value="Public Function GetMetadata () As ClientTwinMetadata" />
      <MemberSignature Language="F#" Value="member this.GetMetadata : unit -&gt; Microsoft.Azure.Devices.ClientTwinMetadata" Usage="clientTwinProperties.GetMetadata " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Devices.ClientTwinMetadata</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Gets the metadata for this collection.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Item">
      <MemberSignature Language="C#" Value="public dynamic this[string propertyName] { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object Item(string)" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwinProperties.Item(System.String)" />
      <MemberSignature Language="VB.NET" Value="Default Public Property Item(propertyName As String) As Object" />
      <MemberSignature Language="F#" Value="member this.Item(string) : obj with get, set" Usage="Microsoft.Azure.Devices.ClientTwinProperties.Item" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="propertyName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="propertyName">Name of the property to get.</param>
        <summary>
            Property indexer.
            </summary>
        <value>Value for the given property name.</value>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">When the specified <paramref name="propertyName" /> does not exist in the collection.</exception>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ClientTwinProperties.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="clientTwinProperties.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <inheritdoc />
      </Docs>
    </Member>
    <Member MemberName="Version">
      <MemberSignature Language="C#" Value="public long Version { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int64 Version" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ClientTwinProperties.Version" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As Long" />
      <MemberSignature Language="F#" Value="member this.Version : int64" Usage="Microsoft.Azure.Devices.ClientTwinProperties.Version" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int64</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the version of the collection.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>