Files
mono/mcs/class/System.Web/Documentation/en/System.Web.Security/FormsAuthenticationTicket.xml
T
2008-10-17 14:12:12 +00:00

234 lines
9.7 KiB
XML
Executable File

<Type Name="FormsAuthenticationTicket" FullName="System.Web.Security.FormsAuthenticationTicket">
<TypeSignature Language="C#" Value="public sealed class FormsAuthenticationTicket" Maintainer="auto" />
<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 />
<Docs>
<summary />
<remarks>
<para>
This class is used together with the FormsAuthentication infrastructure to send information back to a client that needs to be either tamper-proof, or encrypted.
</para>
<para>
This is usually used with the HTTP Cookie mechanism, you would create a FormsAuthenticationTicket, storing the information that must be either tamper-proof, or secret to the client. Once this information is created, you would use the <see cref="M:System.Web.Security.FormsAuthentication.Encrypt(System.Web.Security.FormsAuthenticationTicket)" /> method to encrypt the data and send that information back to the client.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormsAuthenticationTicket (string name, bool isPersistent, int timeout);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="isPersistent" Type="System.Boolean" />
<Parameter Name="timeout" Type="System.Int32" />
</Parameters>
<Docs>
<param name="name">To be added: an object of type 'string'</param>
<param name="isPersistent">To be added: an object of type 'bool'</param>
<param name="timeout">To be added: an object of type 'int'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormsAuthenticationTicket (int version, string name, DateTime issueDate, DateTime expiration, bool isPersistent, string userData);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="version" Type="System.Int32" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="issueDate" Type="System.DateTime" />
<Parameter Name="expiration" Type="System.DateTime" />
<Parameter Name="isPersistent" Type="System.Boolean" />
<Parameter Name="userData" Type="System.String" />
</Parameters>
<Docs>
<param name="version">To be added: an object of type 'int'</param>
<param name="name">To be added: an object of type 'string'</param>
<param name="issueDate">To be added: an object of type 'DateTime'</param>
<param name="expiration">To be added: an object of type 'DateTime'</param>
<param name="isPersistent">To be added: an object of type 'bool'</param>
<param name="userData">To be added: an object of type 'string'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormsAuthenticationTicket (int version, string name, DateTime issueDate, DateTime expiration, bool isPersistent, string userData, string cookiePath);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="version" Type="System.Int32" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="issueDate" Type="System.DateTime" />
<Parameter Name="expiration" Type="System.DateTime" />
<Parameter Name="isPersistent" Type="System.Boolean" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="cookiePath" Type="System.String" />
</Parameters>
<Docs>
<param name="version">To be added: an object of type 'int'</param>
<param name="name">To be added: an object of type 'string'</param>
<param name="issueDate">To be added: an object of type 'DateTime'</param>
<param name="expiration">To be added: an object of type 'DateTime'</param>
<param name="isPersistent">To be added: an object of type 'bool'</param>
<param name="userData">To be added: an object of type 'string'</param>
<param name="cookiePath">To be added: an object of type 'string'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CookiePath">
<MemberSignature Language="C#" Value="public string CookiePath { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Expiration">
<MemberSignature Language="C#" Value="public DateTime Expiration { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'DateTime'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Expired">
<MemberSignature Language="C#" Value="public bool Expired { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsPersistent">
<MemberSignature Language="C#" Value="public bool IsPersistent { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IssueDate">
<MemberSignature Language="C#" Value="public DateTime IssueDate { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'DateTime'</value>
<remarks>To be added</remarks>
</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>
<summary>To be added</summary>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UserData">
<MemberSignature Language="C#" Value="public string UserData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'string'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public int Version { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>