MsalException.xml

<Type Name="MsalException" FullName="Microsoft.Identity.Client.MsalException">
  <TypeSignature Language="C#" Value="public class MsalException : Exception" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MsalException extends System.Exception" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.MsalException" />
  <TypeSignature Language="VB.NET" Value="Public Class MsalException&#xA;Inherits Exception" />
  <TypeSignature Language="F#" Value="type MsalException = class&#xA;    inherit Exception" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Identity.Client</AssemblyName>
    <AssemblyVersion>4.48.1.0</AssemblyVersion>
    <AssemblyVersion>4.49.1.0</AssemblyVersion>
    <AssemblyVersion>4.51.0.0</AssemblyVersion>
    <AssemblyVersion>4.52.0.0</AssemblyVersion>
    <AssemblyVersion>4.53.0.0</AssemblyVersion>
    <AssemblyVersion>4.54.0.0</AssemblyVersion>
    <AssemblyVersion>4.54.1.0</AssemblyVersion>
    <AssemblyVersion>4.55.0.0</AssemblyVersion>
    <AssemblyVersion>4.56.0.0</AssemblyVersion>
    <AssemblyVersion>4.57.0.0</AssemblyVersion>
    <AssemblyVersion>4.58.0.0</AssemblyVersion>
    <AssemblyVersion>4.58.1.0</AssemblyVersion>
    <AssemblyVersion>4.59.0.0</AssemblyVersion>
    <AssemblyVersion>4.60.0.0</AssemblyVersion>
    <AssemblyVersion>4.60.1.0</AssemblyVersion>
    <AssemblyVersion>4.60.2.0</AssemblyVersion>
    <AssemblyVersion>4.60.3.0</AssemblyVersion>
    <AssemblyVersion>4.61.0.0</AssemblyVersion>
    <AssemblyVersion>4.61.1.0</AssemblyVersion>
    <AssemblyVersion>4.61.3.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Exception</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Base exception type thrown when an error occurs during token acquisition.
            For more details, see https://aka.ms/msal-net-exceptions
            </summary>
    <remarks>Avoid throwing this exception. Instead throw the more specialized <see cref="T:Microsoft.Identity.Client.MsalClientException" />
            or <see cref="T:Microsoft.Identity.Client.MsalServiceException" /></remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MsalException ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Initializes a new instance of the exception class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MsalException (string errorCode);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string errorCode) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (errorCode As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Identity.Client.MsalException : string -&gt; Microsoft.Identity.Client.MsalException" Usage="new Microsoft.Identity.Client.MsalException errorCode" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="errorCode" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="errorCode">
            The error code returned by the service or generated by the client. This is the code you can rely on
            for exception handling.
            </param>
        <summary>
            Initializes a new instance of the exception class with a specified
            error code.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MsalException (string errorCode, string errorMessage);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string errorCode, string errorMessage) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (errorCode As String, errorMessage As String)" />
      <MemberSignature Language="F#" Value="new Microsoft.Identity.Client.MsalException : string * string -&gt; Microsoft.Identity.Client.MsalException" Usage="new Microsoft.Identity.Client.MsalException (errorCode, errorMessage)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="errorCode" Type="System.String" />
        <Parameter Name="errorMessage" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="errorCode">
            The error code returned by the service or generated by the client. This is the code you can rely on
            for exception handling.
            </param>
        <param name="errorMessage">The error message that explains the reason for the exception.</param>
        <summary>
            Initializes a new instance of the exception class with a specified
            error code and error message.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public MsalException (string errorCode, string errorMessage, Exception innerException);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string errorCode, string errorMessage, class System.Exception innerException) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.#ctor(System.String,System.String,System.Exception)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (errorCode As String, errorMessage As String, innerException As Exception)" />
      <MemberSignature Language="F#" Value="new Microsoft.Identity.Client.MsalException : string * string * Exception -&gt; Microsoft.Identity.Client.MsalException" Usage="new Microsoft.Identity.Client.MsalException (errorCode, errorMessage, innerException)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="errorCode" Type="System.String" />
        <Parameter Name="errorMessage" Type="System.String" />
        <Parameter Name="innerException" Type="System.Exception" />
      </Parameters>
      <Docs>
        <param name="errorCode">
            The error code returned by the service or generated by the client. This is the code you can rely on
            for exception handling.
            </param>
        <param name="errorMessage">The error message that explains the reason for the exception.</param>
        <param name="innerException">
            The exception that is the cause of the current exception, or a null reference if no inner
            exception is specified.
            </param>
        <summary>
            Initializes a new instance of the exception class with a specified
            error code and a reference to the inner exception that is the cause of
            this exception.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AdditionalExceptionData">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary&lt;string,string&gt; AdditionalExceptionData { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyDictionary`2&lt;string, string&gt; AdditionalExceptionData" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" />
      <MemberSignature Language="VB.NET" Value="Public Property AdditionalExceptionData As IReadOnlyDictionary(Of String, String)" />
      <MemberSignature Language="F#" Value="member this.AdditionalExceptionData : System.Collections.Generic.IReadOnlyDictionary&lt;string, string&gt; with get, set" Usage="Microsoft.Identity.Client.MsalException.AdditionalExceptionData" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A property bag with extra details for this exception.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BrokerErrorCode">
      <MemberSignature Language="C#" Value="public const string BrokerErrorCode;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string BrokerErrorCode" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.BrokerErrorCode" />
      <MemberSignature Language="VB.NET" Value="Public Const BrokerErrorCode As String " />
      <MemberSignature Language="F#" Value="val mutable BrokerErrorCode : string" Usage="Microsoft.Identity.Client.MsalException.BrokerErrorCode" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using desktop brokers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BrokerErrorContext">
      <MemberSignature Language="C#" Value="public const string BrokerErrorContext;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string BrokerErrorContext" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.BrokerErrorContext" />
      <MemberSignature Language="VB.NET" Value="Public Const BrokerErrorContext As String " />
      <MemberSignature Language="F#" Value="val mutable BrokerErrorContext : string" Usage="Microsoft.Identity.Client.MsalException.BrokerErrorContext" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using desktop brokers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BrokerErrorStatus">
      <MemberSignature Language="C#" Value="public const string BrokerErrorStatus;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string BrokerErrorStatus" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.BrokerErrorStatus" />
      <MemberSignature Language="VB.NET" Value="Public Const BrokerErrorStatus As String " />
      <MemberSignature Language="F#" Value="val mutable BrokerErrorStatus : string" Usage="Microsoft.Identity.Client.MsalException.BrokerErrorStatus" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using desktop brokers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BrokerErrorTag">
      <MemberSignature Language="C#" Value="public const string BrokerErrorTag;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string BrokerErrorTag" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.BrokerErrorTag" />
      <MemberSignature Language="VB.NET" Value="Public Const BrokerErrorTag As String " />
      <MemberSignature Language="F#" Value="val mutable BrokerErrorTag : string" Usage="Microsoft.Identity.Client.MsalException.BrokerErrorTag" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using desktop brokers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BrokerTelemetry">
      <MemberSignature Language="C#" Value="public const string BrokerTelemetry;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string BrokerTelemetry" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.BrokerTelemetry" />
      <MemberSignature Language="VB.NET" Value="Public Const BrokerTelemetry As String " />
      <MemberSignature Language="F#" Value="val mutable BrokerTelemetry : string" Usage="Microsoft.Identity.Client.MsalException.BrokerTelemetry" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using desktop brokers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CorrelationId">
      <MemberSignature Language="C#" Value="public string CorrelationId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string CorrelationId" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.MsalException.CorrelationId" />
      <MemberSignature Language="VB.NET" Value="Public Property CorrelationId As String" />
      <MemberSignature Language="F#" Value="member this.CorrelationId : string with get, set" Usage="Microsoft.Identity.Client.MsalException.CorrelationId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An ID that can used to piece up a single authentication flow.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ErrorCode">
      <MemberSignature Language="C#" Value="public string ErrorCode { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ErrorCode" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.MsalException.ErrorCode" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As String" />
      <MemberSignature Language="F#" Value="member this.ErrorCode : string" Usage="Microsoft.Identity.Client.MsalException.ErrorCode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the protocol error code returned by the service or generated by the client. This is the code you can rely on for
            exception handling. Values for this code are typically provided in constant strings in the derived exceptions types
            with explanations of mitigation.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FromJsonString">
      <MemberSignature Language="C#" Value="public static Microsoft.Identity.Client.MsalException FromJsonString (string json);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Client.MsalException FromJsonString(string json) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.FromJsonString(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function FromJsonString (json As String) As MsalException" />
      <MemberSignature Language="F#" Value="static member FromJsonString : string -&gt; Microsoft.Identity.Client.MsalException" Usage="Microsoft.Identity.Client.MsalException.FromJsonString json" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.MsalException</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="json" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="json" />
        <summary>
            Allows re-hydration of the MsalException (or one of its derived types) from JSON generated by ToJsonString().
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsRetryable">
      <MemberSignature Language="C#" Value="public bool IsRetryable { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsRetryable" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.MsalException.IsRetryable" />
      <MemberSignature Language="VB.NET" Value="Public Property IsRetryable As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsRetryable : bool with get, set" Usage="Microsoft.Identity.Client.MsalException.IsRetryable" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Indicates if the previous operation that resulted in this exception should be retried.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ManagedIdentitySource">
      <MemberSignature Language="C#" Value="public const string ManagedIdentitySource;" />
      <MemberSignature Language="ILAsm" Value=".field public static literal string ManagedIdentitySource" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.MsalException.ManagedIdentitySource" />
      <MemberSignature Language="VB.NET" Value="Public Const ManagedIdentitySource As String " />
      <MemberSignature Language="F#" Value="val mutable ManagedIdentitySource : string" Usage="Microsoft.Identity.Client.MsalException.ManagedIdentitySource" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            An <see cref="P:Microsoft.Identity.Client.MsalException.AdditionalExceptionData" /> property key, available when using managed identity.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToJsonString">
      <MemberSignature Language="C#" Value="public string ToJsonString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ToJsonString() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.MsalException.ToJsonString" />
      <MemberSignature Language="VB.NET" Value="Public Function ToJsonString () As String" />
      <MemberSignature Language="F#" Value="member this.ToJsonString : unit -&gt; string" Usage="msalException.ToJsonString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Allows serialization of most values of the exception into JSON.
            </summary>
        <returns />
        <remarks>To be added.</remarks>
      </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.Identity.Client.MsalException.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="msalException.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Creates and returns a string representation of the current exception.
            </summary>
        <returns>A string representation of the current exception.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>