Prompt.xml

<Type Name="Prompt" FullName="Microsoft.Identity.Client.Prompt">
  <TypeSignature Language="C#" Value="public struct Prompt" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Prompt extends System.ValueType" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.Prompt" />
  <TypeSignature Language="VB.NET" Value="Public Structure Prompt" />
  <TypeSignature Language="F#" Value="type Prompt = struct" />
  <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.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Structure containing static members that you can use to specify how the interactive overrides
            of AcquireTokenAsync in <see cref="T:Microsoft.Identity.Client.IPublicClientApplication" /> should prompt the user.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="Consent">
      <MemberSignature Language="C#" Value="public static readonly Microsoft.Identity.Client.Prompt Consent;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Microsoft.Identity.Client.Prompt Consent" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.Prompt.Consent" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Consent As Prompt " />
      <MemberSignature Language="F#" Value=" staticval mutable Consent : Microsoft.Identity.Client.Prompt" Usage="Microsoft.Identity.Client.Prompt.Consent" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.Prompt</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The user will be prompted to consent, even if consent was granted before. It is achieved
            by sending <c>prompt=consent</c> to the authorization server's authorize endpoint.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static readonly Microsoft.Identity.Client.Prompt Create;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Microsoft.Identity.Client.Prompt Create" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.Prompt.Create" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Create As Prompt " />
      <MemberSignature Language="F#" Value=" staticval mutable Create : Microsoft.Identity.Client.Prompt" Usage="Microsoft.Identity.Client.Prompt.Create" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.Prompt</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            AcquireToken will send <c>prompt=create</c> to the authorization server's authorize endpoint
            which would trigger a sign-up experience, used for External Identities. 
            </summary>
        <remarks>More details at https://aka.ms/msal-net-prompt-create. </remarks>
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Prompt.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="prompt.Equals obj" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="obj" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="obj">object to compare against</param>
        <summary>
            Equals method override to compare Prompt structs
            </summary>
        <returns>true if object are equal.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ForceLogin">
      <MemberSignature Language="C#" Value="public static readonly Microsoft.Identity.Client.Prompt ForceLogin;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Microsoft.Identity.Client.Prompt ForceLogin" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.Prompt.ForceLogin" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ForceLogin As Prompt " />
      <MemberSignature Language="F#" Value=" staticval mutable ForceLogin : Microsoft.Identity.Client.Prompt" Usage="Microsoft.Identity.Client.Prompt.ForceLogin" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.Prompt</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The user will be prompted for credentials by the service. It is achieved
            by sending <c>prompt=login</c> to the authorize endpoint.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Prompt.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="prompt.GetHashCode " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Override to compute hash code
            </summary>
        <returns>hash code of the PromptValue</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="NoPrompt">
      <MemberSignature Language="C#" Value="public static readonly Microsoft.Identity.Client.Prompt NoPrompt;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Microsoft.Identity.Client.Prompt NoPrompt" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.Prompt.NoPrompt" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly NoPrompt As Prompt " />
      <MemberSignature Language="F#" Value=" staticval mutable NoPrompt : Microsoft.Identity.Client.Prompt" Usage="Microsoft.Identity.Client.Prompt.NoPrompt" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.Prompt</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Let the identity service decide on the best user experience, based on browser cookies and 
            on the login hint, which can be specified using WithAccount() or WithLoginHint()
            </summary>
        <remarks>This is the recommended prompt</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Equality">
      <MemberSignature Language="C#" Value="public static bool operator == (Microsoft.Identity.Client.Prompt x, Microsoft.Identity.Client.Prompt y);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Microsoft.Identity.Client.Prompt x, valuetype Microsoft.Identity.Client.Prompt y) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Prompt.op_Equality(Microsoft.Identity.Client.Prompt,Microsoft.Identity.Client.Prompt)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator == (x As Prompt, y As Prompt) As Boolean" />
      <MemberSignature Language="F#" Value="static member ( = ) : Microsoft.Identity.Client.Prompt * Microsoft.Identity.Client.Prompt -&gt; bool" Usage="x = y" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="Microsoft.Identity.Client.Prompt" />
        <Parameter Name="y" Type="Microsoft.Identity.Client.Prompt" />
      </Parameters>
      <Docs>
        <param name="x">first value</param>
        <param name="y">second value</param>
        <summary>
            Operator overload to check equality
            </summary>
        <returns>true if the objects are equal</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Inequality">
      <MemberSignature Language="C#" Value="public static bool operator != (Microsoft.Identity.Client.Prompt x, Microsoft.Identity.Client.Prompt y);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Microsoft.Identity.Client.Prompt x, valuetype Microsoft.Identity.Client.Prompt y) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.Prompt.op_Inequality(Microsoft.Identity.Client.Prompt,Microsoft.Identity.Client.Prompt)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Operator != (x As Prompt, y As Prompt) As Boolean" />
      <MemberSignature Language="F#" Value="static member op_Inequality : Microsoft.Identity.Client.Prompt * Microsoft.Identity.Client.Prompt -&gt; bool" Usage="Microsoft.Identity.Client.Prompt.op_Inequality (x, y)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="Microsoft.Identity.Client.Prompt" />
        <Parameter Name="y" Type="Microsoft.Identity.Client.Prompt" />
      </Parameters>
      <Docs>
        <param name="x">first value</param>
        <param name="y">second value</param>
        <summary>
            Operator overload to check inequality
            </summary>
        <returns>true if the objects are not equal</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SelectAccount">
      <MemberSignature Language="C#" Value="public static readonly Microsoft.Identity.Client.Prompt SelectAccount;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Microsoft.Identity.Client.Prompt SelectAccount" />
      <MemberSignature Language="DocId" Value="F:Microsoft.Identity.Client.Prompt.SelectAccount" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly SelectAccount As Prompt " />
      <MemberSignature Language="F#" Value=" staticval mutable SelectAccount : Microsoft.Identity.Client.Prompt" Usage="Microsoft.Identity.Client.Prompt.SelectAccount" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Identity.Client</AssemblyName>
        <AssemblyVersion>4.61.3.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Identity.Client.Prompt</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            AcquireToken will send <c>prompt=select_account</c> to the authorization server's authorize endpoint.
            which would present to the user a list of accounts from which one can be selected for
            authentication.
            </summary>
        <remarks>
            This is the default prompt for backwards compatibility reasons. Please use <see cref="F:Microsoft.Identity.Client.Prompt.NoPrompt" /> for the best user experience.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>