1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
<?xml version="1.0" encoding="utf-8"?>
<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 <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> class is used to create an object that represents the authentication ticket that is used by forms authentication to identify an authenticated user. The properties and values of a forms-authentication ticket are converted to and from an encrypted string that is stored in a cookie or in the URL.</para>
<para>The <see cref="T:System.Web.Security.FormsAuthentication" /> class provides an <see cref="M:System.Web.Security.FormsAuthentication.Encrypt(System.Web.Security.FormsAuthenticationTicket)" /> method to create a string value that can be stored in a cookie or in the URL from a <see cref="T:System.Web.Security.FormsAuthenticationTicket" />. The <see cref="T:System.Web.Security.FormsAuthentication" /> class also provides a <see cref="M:System.Web.Security.FormsAuthentication.Decrypt(System.String)" /> method to create a <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> object from the encrypted authentication ticket retrieved from the forms-authentication cookie or the URL.</para>
<para>The <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> for the current authenticated user can be accessed using the <see cref="P:System.Web.Security.FormsIdentity.Ticket" /> property of the <see cref="T:System.Web.Security.FormsIdentity" /> class. You can access the current <see cref="T:System.Web.Security.FormsIdentity" /> object by casting the <see cref="P:System.Security.Principal.IPrincipal.Identity" /> property of the current <see cref="P:System.Web.HttpContext.User" /> as type <see cref="T:System.Web.Security.FormsIdentity" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides access to properties and values of the ticket used with forms authentication to identify users. This class cannot be inherited.</para>
</summary>
</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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> object created by this constructor will have a <see cref="P:System.Web.Security.FormsAuthenticationTicket.CookiePath" /> value set to the value of the <see cref="P:System.Web.Security.FormsAuthentication.FormsCookiePath" /> property, a <see cref="P:System.Web.Security.FormsAuthenticationTicket.Version" /> value of 2, an <see cref="P:System.Web.Security.FormsAuthenticationTicket.IssueDate" /> value of the current local date and time, a <see cref="P:System.Web.Security.FormsAuthenticationTicket.UserData" /> value of an empty string (""), and an <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> value that is set to the current local date and time plus the value of the <paramref name="timeout" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> class using a cookie name and expiration information.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the ticket.</param>
<param name="isPersistent">
<attribution license="cc4" from="Microsoft" modified="false" />true if the ticket will be stored in a persistent cookie (saved across browser sessions); otherwise, false. If the ticket is stored in the URL, this value is ignored.</param>
<param name="timeout">
<attribution license="cc4" from="Microsoft" modified="false" />The time, in minutes, for which the authentication ticket is valid.</param>
</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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> object created by this constructor will have a <see cref="P:System.Web.Security.FormsAuthenticationTicket.CookiePath" /> value set to the value of the <see cref="P:System.Web.Security.FormsAuthentication.FormsCookiePath" />.</para>
<block subset="none" type="note">
<para>The <paramref name="userData" /> parameter cannot be null.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> class with cookie name, version, expiration date, issue date, persistence, and user-specific data. The cookie path is set to the default value established in the application's configuration file.</para>
</summary>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version number of the ticket.</param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the ticket.</param>
<param name="issueDate">
<attribution license="cc4" from="Microsoft" modified="false" />The local date and time at which the ticket was issued.</param>
<param name="expiration">
<attribution license="cc4" from="Microsoft" modified="false" />The local date and time at which the ticket expires.</param>
<param name="isPersistent">
<attribution license="cc4" from="Microsoft" modified="false" />true if the ticket will be stored in a persistent cookie (saved across browser sessions); otherwise, false. If the ticket is stored in the URL, this value is ignored.</param>
<param name="userData">
<attribution license="cc4" from="Microsoft" modified="false" />The user-specific data to be stored with the ticket.</param>
</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>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<block subset="none" type="note">
<para>The <paramref name="userData" /> parameter cannot be null. </para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> class with cookie name, version, directory path, issue date, expiration date, persistence, and user-defined data.</para>
</summary>
<param name="version">
<attribution license="cc4" from="Microsoft" modified="false" />The version number of the ticket. </param>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The user name associated with the ticket. </param>
<param name="issueDate">
<attribution license="cc4" from="Microsoft" modified="false" />The local date and time at which the ticket was issued. </param>
<param name="expiration">
<attribution license="cc4" from="Microsoft" modified="false" />The local date and time at which the ticket expires. </param>
<param name="isPersistent">
<attribution license="cc4" from="Microsoft" modified="false" />true if the ticket will be stored in a persistent cookie (saved across browser sessions); otherwise, false. If the ticket is stored in the URL, this value is ignored.</param>
<param name="userData">
<attribution license="cc4" from="Microsoft" modified="false" />The user-specific data to be stored with the ticket. </param>
<param name="cookiePath">
<attribution license="cc4" from="Microsoft" modified="false" />The path for the ticket when stored in a cookie. </param>
</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>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> is created using a constructor that does not supply a <paramref name="cookiePath" /> parameter, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.CookiePath" /> property returns the value of the <see cref="P:System.Web.Security.FormsAuthentication.FormsCookiePath" /> property; otherwise, the version property returns the value supplied to the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the cookie path for the forms-authentication ticket.</para>
</summary>
</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>
<value>To be added: an object of type 'DateTime'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> is created using the <see cref="M:System.Web.Security.FormsAuthenticationTicket.#ctor(System.String,System.Boolean,System.Int32)" /> constructor that does not supply a parameter for an expiration date and time, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> property returns a value based on the current local date and time plus the value of the <paramref name="timeout" /> parameter supplied to the constructor.</para>
<para>If the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> was created using a constructor that takes an <paramref name="expiration" /> parameter, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> property returns the value supplied to the <paramref name="expiration" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the local date and time at which the forms-authentication ticket expires.</para>
</summary>
</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>
<value>To be added: an object of type 'bool'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expired" /> property returns true if the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> date and time is less than the current local date and time; otherwise, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expired" /> property returns false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the forms-authentication ticket has expired.</para>
</summary>
</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>
<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 indicating whether the cookie that contains the forms-authentication ticket information is persistent.</para>
</summary>
</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>
<value>To be added: an object of type 'DateTime'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.FormsAuthenticationTicket.IssueDate" /> property represents the local date and time when the forms-authentication ticket was issued. The <see cref="M:System.Web.Security.FormsAuthentication.RenewTicketIfOld(System.Web.Security.FormsAuthenticationTicket)" /> method uses the <see cref="P:System.Web.Security.FormsAuthenticationTicket.IssueDate" /> property value to determine whether the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> date and time of a forms-authentication ticket needs to be renewed and also uses the <see cref="P:System.Web.Security.FormsAuthenticationTicket.IssueDate" /> property value to determine the new <see cref="P:System.Web.Security.FormsAuthenticationTicket.Expiration" /> date and time. When a ticket is renewed, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.IssueDate" /> property is updated to the local date and time.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the local date and time at which the forms-authentication ticket was originally issued.</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>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the user name associated with the forms-authentication ticket.</para>
</summary>
</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>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> is created using a constructor that does not supply a <paramref name="userData" /> parameter, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.UserData" /> property returns an empty string (""); otherwise, the version property returns the value supplied to the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> constructor.</para>
<para>You can use the <see cref="P:System.Web.Security.FormsAuthenticationTicket.UserData" /> property to store additional user information with the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> that is not maintained by the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> property values.</para>
<block subset="none" type="note">
<para>You should limit the amount of data stored in the <see cref="P:System.Web.Security.FormsAuthenticationTicket.UserData" /> property. You must ensure that the size of the <see cref="P:System.Web.Security.FormsAuthenticationTicket.UserData" /> property does not result in an invalid cookie or an excessively long URL.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a user-specific string stored with the ticket.</para>
</summary>
</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>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> is created using a constructor that does not supply a <paramref name="version" /> parameter, the <see cref="P:System.Web.Security.FormsAuthenticationTicket.Version" /> property returns 2; otherwise, the version property returns the value supplied to the <see cref="T:System.Web.Security.FormsAuthenticationTicket" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the version number of the ticket.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|
