Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

132 lines
6.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="FormsIdentity" FullName="System.Web.Security.FormsIdentity">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class FormsIdentity : System.Security.Principal.IIdentity" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Security.Principal.IIdentity</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.FormsIdentity" /> class is used by the <see cref="T:System.Web.Security.FormsAuthenticationModule" /> when a user is authenticated with forms authentication. An instance of the <see cref="T:System.Web.Security.FormsIdentity" /> class is created using the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> that is decrypted from the forms-authentication cookie or from the URL. The new instance of the <see cref="T:System.Web.Security.FormsIdentity" /> class is used to construct a new <see cref="T:System.Security.Principal.GenericPrincipal" /> object that is set as the value of the <see cref="P:System.Web.HttpContext.User" /> property for the current <see cref="T:System.Web.HttpContext" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a user identity authenticated using forms authentication. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormsIdentity (System.Web.Security.FormsAuthenticationTicket ticket);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="ticket" Type="System.Web.Security.FormsAuthenticationTicket" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Security.FormsIdentity" /> class.</para>
</summary>
<param name="ticket">
<attribution license="cc4" from="Microsoft" modified="false" />The authentication ticket upon which this identity is based. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AuthenticationType">
<MemberSignature Language="C#" Value="public string AuthenticationType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of authenticated identity.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsAuthenticated">
<MemberSignature Language="C#" Value="public bool IsAuthenticated { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether authentication took place.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.FormsIdentity.Name" /> property returns the value of the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Name" /> property from the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> supplied to the constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the user name of the forms identity.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Ticket">
<MemberSignature Language="C#" Value="public System.Web.Security.FormsAuthenticationTicket Ticket { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.FormsAuthenticationTicket</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'FormsAuthenticationTicket'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> for the forms-authentication user identity.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>