ProvisioningClientException.xml

<Type Name="ProvisioningClientException" FullName="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException">
  <TypeSignature Language="C#" Value="public class ProvisioningClientException : Exception" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ProvisioningClientException extends System.Exception" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException" />
  <TypeSignature Language="VB.NET" Value="Public Class ProvisioningClientException&#xA;Inherits Exception" />
  <TypeSignature Language="F#" Value="type ProvisioningClientException = class&#xA;    inherit Exception" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Exception</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            The exception that is thrown when an error occurs during device provisioning client operation.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected internal ProvisioningClientException (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Sub New (info As SerializationInfo, context As StreamingContext)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -&gt; Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException (info, context)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
        <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
        <summary>
            Creates a new instance of this class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected internal ProvisioningClientException (string message, bool isTransient);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(string message, bool isTransient) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.#ctor(System.String,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Sub New (message As String, isTransient As Boolean)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException : string * bool -&gt; Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException (message, isTransient)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="isTransient" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="message">The exception message.</param>
        <param name="isTransient">True if the error is transient.</param>
        <summary>
            Creates a new instance of this class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected internal ProvisioningClientException (string message, Exception innerException, bool isTransient);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception innerException, bool isTransient) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.#ctor(System.String,System.Exception,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Sub New (message As String, innerException As Exception, isTransient As Boolean)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException : string * Exception * bool -&gt; Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException (message, innerException, isTransient)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="innerException" Type="System.Exception" />
        <Parameter Name="isTransient" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="message">The exception message.</param>
        <param name="isTransient">True if the error is transient.</param>
        <param name="innerException">The inner exception.</param>
        <summary>
            Creates a new instance of this class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected internal ProvisioningClientException (string message, Exception innerException, bool isTransient, int errorCode, string trackingId);" />
      <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception innerException, bool isTransient, int32 errorCode, string trackingId) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.#ctor(System.String,System.Exception,System.Boolean,System.Int32,System.String)" />
      <MemberSignature Language="VB.NET" Value="Protected Friend Sub New (message As String, innerException As Exception, isTransient As Boolean, errorCode As Integer, trackingId As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException : string * Exception * bool * int * string -&gt; Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException" Usage="new Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException (message, innerException, isTransient, errorCode, trackingId)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="innerException" Type="System.Exception" />
        <Parameter Name="isTransient" Type="System.Boolean" />
        <Parameter Name="errorCode" Type="System.Int32" />
        <Parameter Name="trackingId" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="message">The exception message.</param>
        <param name="innerException">The inner exception.</param>
        <param name="isTransient">If the error is transient and the application should retry at a later time.</param>
        <param name="errorCode">The specific 6-digit error code in the DPS response, if available.</param>
        <param name="trackingId">Service reported tracking Id.</param>
        <summary>
            Creates a new instance of this class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ErrorCode">
      <MemberSignature Language="C#" Value="public int ErrorCode { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 ErrorCode" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.ErrorCode" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As Integer" />
      <MemberSignature Language="F#" Value="member this.ErrorCode : int" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.ErrorCode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The specific 6-digit error code in the DPS response, if available.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetObjectData">
      <MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Sub GetObjectData (info As SerializationInfo, context As StreamingContext)" />
      <MemberSignature Language="F#" Value="override this.GetObjectData : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -&gt; unit" Usage="provisioningClientException.GetObjectData (info, context)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
        <Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
      </Parameters>
      <Docs>
        <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
        <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
        <summary>
            Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsTransient">
      <MemberSignature Language="C#" Value="public bool IsTransient { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsTransient" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.IsTransient" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsTransient As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsTransient : bool" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.IsTransient" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            If true, the error is transient and the application should retry at a later time.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TrackingId">
      <MemberSignature Language="C#" Value="public string TrackingId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TrackingId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.TrackingId" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TrackingId As String" />
      <MemberSignature Language="F#" Value="member this.TrackingId : string" Usage="Microsoft.Azure.Devices.Provisioning.Client.ProvisioningClientException.TrackingId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Devices.Provisioning.Client</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Service reported tracking Id. Use this when reporting a service issue.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>