IdentityCookieOptions.xml

<Type Name="IdentityCookieOptions" FullName="Microsoft.AspNetCore.Identity.IdentityCookieOptions">
  <TypeSignature Language="C++ CLI" Value="public ref class IdentityCookieOptions" />
  <TypeSignature Language="C#" Value="public class IdentityCookieOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IdentityCookieOptions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Identity.IdentityCookieOptions" />
  <TypeSignature Language="VB.NET" Value="Public Class IdentityCookieOptions" />
  <TypeSignature Language="F#" Value="type IdentityCookieOptions = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Represents all the options you can use to configure the cookies middleware uesd by the identity system.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; IdentityCookieOptions();" />
      <MemberSignature Language="C#" Value="public IdentityCookieOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Identity.IdentityCookieOptions.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>
            Constructs a new instance of <see cref="T:Microsoft.AspNetCore.Identity.IdentityCookieOptions" />.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplicationCookie">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ ApplicationCookie { Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ get(); void set(Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ value); };" />
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Builder.CookieAuthenticationOptions ApplicationCookie { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Builder.CookieAuthenticationOptions ApplicationCookie" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.ApplicationCookie" />
      <MemberSignature Language="VB.NET" Value="Public Property ApplicationCookie As CookieAuthenticationOptions" />
      <MemberSignature Language="F#" Value="member this.ApplicationCookie : Microsoft.AspNetCore.Builder.CookieAuthenticationOptions with get, set" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.ApplicationCookie" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.AspNetCore.Builder.CookieAuthenticationOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The options for the application cookie.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApplicationCookieAuthenticationScheme">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ ApplicationCookieAuthenticationScheme { System::String ^ get(); };" />
      <MemberSignature Language="C#" Value="public string ApplicationCookieAuthenticationScheme { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ApplicationCookieAuthenticationScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.ApplicationCookieAuthenticationScheme" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApplicationCookieAuthenticationScheme As String" />
      <MemberSignature Language="F#" Value="member this.ApplicationCookieAuthenticationScheme : string" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.ApplicationCookieAuthenticationScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the scheme used to identify application authentication cookies.
            </summary>
        <value>The scheme used to identify application authentication cookies.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ExternalCookie">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ ExternalCookie { Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ get(); void set(Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ value); };" />
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Builder.CookieAuthenticationOptions ExternalCookie { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Builder.CookieAuthenticationOptions ExternalCookie" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.ExternalCookie" />
      <MemberSignature Language="VB.NET" Value="Public Property ExternalCookie As CookieAuthenticationOptions" />
      <MemberSignature Language="F#" Value="member this.ExternalCookie : Microsoft.AspNetCore.Builder.CookieAuthenticationOptions with get, set" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.ExternalCookie" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.AspNetCore.Builder.CookieAuthenticationOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The options for the external cookie.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ExternalCookieAuthenticationScheme">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ ExternalCookieAuthenticationScheme { System::String ^ get(); };" />
      <MemberSignature Language="C#" Value="public string ExternalCookieAuthenticationScheme { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ExternalCookieAuthenticationScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.ExternalCookieAuthenticationScheme" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExternalCookieAuthenticationScheme As String" />
      <MemberSignature Language="F#" Value="member this.ExternalCookieAuthenticationScheme : string" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.ExternalCookieAuthenticationScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the scheme used to identify external authentication cookies.
            </summary>
        <value>The scheme used to identify external authentication cookies.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TwoFactorRememberMeCookie">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ TwoFactorRememberMeCookie { Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ get(); void set(Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ value); };" />
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Builder.CookieAuthenticationOptions TwoFactorRememberMeCookie { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Builder.CookieAuthenticationOptions TwoFactorRememberMeCookie" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorRememberMeCookie" />
      <MemberSignature Language="VB.NET" Value="Public Property TwoFactorRememberMeCookie As CookieAuthenticationOptions" />
      <MemberSignature Language="F#" Value="member this.TwoFactorRememberMeCookie : Microsoft.AspNetCore.Builder.CookieAuthenticationOptions with get, set" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorRememberMeCookie" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.AspNetCore.Builder.CookieAuthenticationOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The options for the two factor remember me cookie.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TwoFactorRememberMeCookieAuthenticationScheme">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ TwoFactorRememberMeCookieAuthenticationScheme { System::String ^ get(); };" />
      <MemberSignature Language="C#" Value="public string TwoFactorRememberMeCookieAuthenticationScheme { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TwoFactorRememberMeCookieAuthenticationScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorRememberMeCookieAuthenticationScheme" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TwoFactorRememberMeCookieAuthenticationScheme As String" />
      <MemberSignature Language="F#" Value="member this.TwoFactorRememberMeCookieAuthenticationScheme : string" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorRememberMeCookieAuthenticationScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the scheme used to identify Two Factor authentication cookies for saving the Remember Me state.
            </summary>
        <value>The scheme used to identify remember me application authentication cookies.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TwoFactorUserIdCookie">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ TwoFactorUserIdCookie { Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ get(); void set(Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^ value); };" />
      <MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Builder.CookieAuthenticationOptions TwoFactorUserIdCookie { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Builder.CookieAuthenticationOptions TwoFactorUserIdCookie" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorUserIdCookie" />
      <MemberSignature Language="VB.NET" Value="Public Property TwoFactorUserIdCookie As CookieAuthenticationOptions" />
      <MemberSignature Language="F#" Value="member this.TwoFactorUserIdCookie : Microsoft.AspNetCore.Builder.CookieAuthenticationOptions with get, set" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorUserIdCookie" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.AspNetCore.Builder.CookieAuthenticationOptions</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The options for the two factor user id cookie.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TwoFactorUserIdCookieAuthenticationScheme">
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ TwoFactorUserIdCookieAuthenticationScheme { System::String ^ get(); };" />
      <MemberSignature Language="C#" Value="public string TwoFactorUserIdCookieAuthenticationScheme { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TwoFactorUserIdCookieAuthenticationScheme" />
      <MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorUserIdCookieAuthenticationScheme" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property TwoFactorUserIdCookieAuthenticationScheme As String" />
      <MemberSignature Language="F#" Value="member this.TwoFactorUserIdCookieAuthenticationScheme : string" Usage="Microsoft.AspNetCore.Identity.IdentityCookieOptions.TwoFactorUserIdCookieAuthenticationScheme" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.AspNetCore.Identity</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the scheme used to identify Two Factor authentication cookies for round tripping user identities.
            </summary>
        <value>The scheme used to identify user identity 2fa authentication cookies.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>