当前文件路径：DNN/Website/Bin/DotNetNuke.Provider.AspNetProvider.xml

		            
  1<?xml version="1.0"?>
  2<doc>
  3<assembly>
  4<name>
  5DotNetNuke.Provider.AspNetProvider
  6</name>
  7</assembly>
  8<members>
  9<member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.CreateDNNUser(DotNetNuke.Entities.Users.UserInfo@)">
 10 -----------------------------------------------------------------------------
 11 <summary>
 12 CreateDNNUser persists the DNN User information to the Database
 13 </summary>
 14    <remarks>
 15    </remarks>
 16    <param name="user">The user to persist to the Data Store.</param>
 17    <returns>The UserId of the newly created user.</returns>
 18    <history>
 19     [cnurse]    12/13/2005    created
 20 </history>
 21 -----------------------------------------------------------------------------
 22
 23</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.CreateMemberhipUser(DotNetNuke.Entities.Users.UserInfo)">
 24 -----------------------------------------------------------------------------
 25 <summary>
 26 CreateMemberhipUser persists the User as an AspNet MembershipUser to the AspNet
 27 Data Store
 28 </summary>
 29    <remarks>
 30    </remarks>
 31    <param name="user">The user to persist to the Data Store.</param>
 32    <returns>A UserCreateStatus enumeration indicating success or reason for failure.</returns>
 33    <history>
 34     [cnurse]    12/13/2005    created
 35 </history>
 36 -----------------------------------------------------------------------------
 37
 38</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.DeleteMembershipUser(DotNetNuke.Entities.Users.UserInfo)">
 39 -----------------------------------------------------------------------------
 40 <summary>
 41 DeleteMembershipUser deletes the User as an AspNet MembershipUser from the AspNet
 42 Data Store
 43 </summary>
 44    <remarks>
 45    </remarks>
 46    <param name="user">The user to delete from the Data Store.</param>
 47    <returns>A Boolean indicating success or failure.</returns>
 48    <history>
 49     [cnurse]    12/22/2005    created
 50 </history>
 51 -----------------------------------------------------------------------------
 52
 53</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.FillUserCollection(System.Int32,System.Data.IDataReader,System.Boolean,System.Int32@)">
 54 -----------------------------------------------------------------------------
 55 <summary>
 56 FillUserCollection fills an ArrayList from a collection Asp.Net MembershipUsers
 57 </summary>
 58    <remarks>
 59    </remarks>
 60    <param name="portalId">The Id of the Portal</param>
 61    <param name="dr">The data reader corresponding to the User.</param>
 62    <param name="isHydrated">A flag that determines whether the user is hydrated.</param>
 63    <returns>An ArrayList of UserInfo objects.</returns>
 64    <history>
 65     [cnurse]    03/30/2006    created
 66 </history>
 67 -----------------------------------------------------------------------------
 68
 69</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.FillUserCollection(System.Int32,System.Data.IDataReader,System.Boolean)">
 70 -----------------------------------------------------------------------------
 71 <summary>
 72 FillUserCollection fills an ArrayList from a collection Asp.Net MembershipUsers
 73 </summary>
 74    <remarks>
 75    </remarks>
 76    <param name="portalId">The Id of the Portal</param>
 77    <param name="dr">The data reader corresponding to the User.</param>
 78    <param name="isHydrated">A flag that determines whether the user is hydrated.</param>
 79    <returns>An ArrayList of UserInfo objects.</returns>
 80    <history>
 81     [cnurse]    06/15/2006    created
 82 </history>
 83 -----------------------------------------------------------------------------
 84
 85</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.FillUserInfo(System.Int32,System.Data.IDataReader,System.Boolean,System.Boolean)">
 86 -----------------------------------------------------------------------------
 87 <summary>
 88 FillUserInfo fills a User Info object from a data reader
 89 </summary>
 90    <remarks>
 91    </remarks>
 92    <param name="portalId">The Id of the Portal</param>
 93    <param name="dr">The data reader corresponding to the User.</param>
 94    <param name="isHydrated">A flag that determines whether the user is hydrated.</param>
 95    <param name="CheckForOpenDataReader">Flag to determine whether to chcek if the datareader is open</param>
 96    <returns>The User as a UserInfo object</returns>
 97    <history>
 98     [cnurse]    12/13/2005    created
 99 </history>
100 -----------------------------------------------------------------------------
101
102</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.FillUserMembership(System.Web.Security.MembershipUser,DotNetNuke.Entities.Users.UserInfo)">
103 -----------------------------------------------------------------------------
104 <summary>
105 Builds a UserMembership object from an AspNet MembershipUser
106 </summary>
107    <remarks>
108    </remarks>
109    <param name="aspNetUser">The MembershipUser object to use to fill the DNN UserMembership.</param>
110    <history>
111     [cnurse]    12/10/2005    created
112 </history>
113 -----------------------------------------------------------------------------
114
115</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.GetMembershipUser(DotNetNuke.Entities.Users.UserInfo)">
116 -----------------------------------------------------------------------------
117 <summary>
118 Gets an AspNet MembershipUser from the DataStore
119 </summary>
120    <param name="user">The user to get from the Data Store.</param>
121    <returns>The User as a AspNet MembershipUser object</returns>
122    <history>
123     [cnurse]    12/10/2005    created
124 </history>
125 -----------------------------------------------------------------------------
126
127</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.GetMembershipUser(System.String)">
128 -----------------------------------------------------------------------------
129 <summary>
130 Gets an AspNet MembershipUser from the DataStore
131 </summary>
132    <param name="userName">The name of the user.</param>
133    <returns>The User as a AspNet MembershipUser object</returns>
134    <history>
135     [cnurse]    04/25/2006    created
136 </history>
137 -----------------------------------------------------------------------------
138
139</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.GetTotalRecords(System.Data.IDataReader@)">
140 -----------------------------------------------------------------------------
141 <summary>
142 The GetTotalRecords method gets the number of Records returned.
143 </summary>
144    <param name="dr">An <see cref="T:System.Data.IDataReader"/> containing the Total no of records</param>
145    <returns>An Integer</returns>
146    <history>
147     [cnurse]    03/30/2006    Created
148 </history>
149 -----------------------------------------------------------------------------
150
151</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.GetUserByAuthToken(System.Int32,System.String,System.String,System.Boolean)">
152 -----------------------------------------------------------------------------
153 <summary>
154 GetUserByAuthToken retrieves a User from the DataStore using an Authentication Token
155 </summary>
156    <remarks>
157    </remarks>
158    <param name="portalId">The Id of the Portal</param>
159    <param name="userToken">The authentication token of the user being retrieved from the Data Store.</param>
160    <param name="authType">The type of Authentication Used</param>
161    <param name="isHydrated">A flag that determines whether the user is hydrated.</param>
162    <returns>The User as a UserInfo object</returns>
163    <history>
164     [cnurse]    07/09/2007    created
165 </history>
166 -----------------------------------------------------------------------------
167
168</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.UpdateUserMembership(DotNetNuke.Entities.Users.UserInfo)">
169 -----------------------------------------------------------------------------
170 <summary>
171 UpdateUserMembership persists a user's Membership to the Data Store
172 </summary>
173    <remarks>
174    </remarks>
175    <param name="user">The user to persist to the Data Store.</param>
176    <history>
177     [cnurse]    12/13/2005    created
178 </history>
179 -----------------------------------------------------------------------------
180
181</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.ValidateUser(System.Int32,System.String,System.String)">
182 -----------------------------------------------------------------------------
183 <summary>
184 Validates the users credentials against the Data Store
185 </summary>
186    <remarks>
187    </remarks>
188    <param name="portalId">The Id of the Portal the user belongs to</param>
189    <param name="username">The user name of the User attempting to log in</param>
190    <param name="password">The password of the User attempting to log in</param>
191    <returns>A Boolean result</returns>
192    <history>
193     [cnurse]    12/12/2005    created
194 </history>
195 -----------------------------------------------------------------------------
196
197</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.CanEditProviderProperties">
198 -----------------------------------------------------------------------------
199 <summary>
200 Gets whether the Provider Properties can be edited
201 </summary>
202    <returns>A Boolean</returns>
203    <history>
204     [cnurse]    03/02/2006    created
205 </history>
206 -----------------------------------------------------------------------------
207
208</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.MaxInvalidPasswordAttempts">
209 -----------------------------------------------------------------------------
210 <summary>
211 Gets and sets the maximum number of invlaid attempts to login are allowed
212 </summary>
213    <returns>A Boolean.</returns>
214    <history>
215     [cnurse]    03/02/2006    created
216 </history>
217 -----------------------------------------------------------------------------
218
219</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.MinNonAlphanumericCharacters">
220 -----------------------------------------------------------------------------
221 <summary>
222 Gets and sets the Mimimum no of Non AlphNumeric characters required
223 </summary>
224    <returns>An Integer.</returns>
225    <history>
226     [cnurse]    02/07/2006    created
227 </history>
228 -----------------------------------------------------------------------------
229
230</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.MinPasswordLength">
231 -----------------------------------------------------------------------------
232 <summary>
233 Gets and sets the Mimimum Password Length
234 </summary>
235    <returns>An Integer.</returns>
236    <history>
237     [cnurse]    02/07/2006    created
238 </history>
239 -----------------------------------------------------------------------------
240
241</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.PasswordAttemptWindow">
242 -----------------------------------------------------------------------------
243 <summary>
244 Gets and sets the window in minutes that the maxium attempts are tracked for
245 </summary>
246    <returns>A Boolean.</returns>
247    <history>
248     [cnurse]    03/02/2006    created
249 </history>
250 -----------------------------------------------------------------------------
251
252</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.PasswordFormat">
253 -----------------------------------------------------------------------------
254 <summary>
255 Gets and sets the Password Format as set in the web.config file
256 </summary>
257    <returns>A PasswordFormat enumeration.</returns>
258    <history>
259     [cnurse]    02/07/2006    created
260 </history>
261 -----------------------------------------------------------------------------
262
263</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.PasswordResetEnabled">
264 -----------------------------------------------------------------------------
265 <summary>
266 Gets and sets whether the Users's Password can be reset
267 </summary>
268    <returns>A Boolean.</returns>
269    <history>
270     [cnurse]    03/02/2006    created
271 </history>
272 -----------------------------------------------------------------------------
273
274</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.PasswordRetrievalEnabled">
275 -----------------------------------------------------------------------------
276 <summary>
277 Gets and sets whether the Users's Password can be retrieved
278 </summary>
279    <returns>A Boolean.</returns>
280    <history>
281     [cnurse]    03/02/2006    created
282 </history>
283 -----------------------------------------------------------------------------
284
285</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.RequiresQuestionAndAnswer">
286 -----------------------------------------------------------------------------
287 <summary>
288 Gets and sets whether a Question/Answer is required for Password retrieval
289 </summary>
290    <returns>A Boolean.</returns>
291    <history>
292     [cnurse]    02/07/2006    created
293 </history>
294 -----------------------------------------------------------------------------
295
296</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.PasswordStrengthRegularExpression">
297 -----------------------------------------------------------------------------
298 <summary>
299 Gets and sets a Regular Expression that deermines the strength of the password
300 </summary>
301    <returns>A String.</returns>
302    <history>
303     [cnurse]    02/07/2006    created
304 </history>
305 -----------------------------------------------------------------------------
306
307</member><member name="P:DotNetNuke.Security.Membership.AspNetMembershipProvider.RequiresUniqueEmail">
308 -----------------------------------------------------------------------------
309 <summary>
310 Gets and sets whether a Unique Email is required
311 </summary>
312    <returns>A Boolean.</returns>
313    <history>
314     [cnurse]    02/06/2007    created
315 </history>
316 -----------------------------------------------------------------------------
317
318</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.ChangePassword(DotNetNuke.Entities.Users.UserInfo,System.String,System.String)">
319 -----------------------------------------------------------------------------
320 <summary>
321 ChangePassword attempts to change the users password
322 </summary>
323    <remarks>
324    </remarks>
325    <param name="user">The user to update.</param>
326    <param name="oldPassword">The old password.</param>
327    <param name="newPassword">The new password.</param>
328    <returns>A Boolean indicating success or failure.</returns>
329    <history>
330     [cnurse]    12/13/2005    created
331 </history>
332 -----------------------------------------------------------------------------
333
334</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.ChangePasswordQuestionAndAnswer(DotNetNuke.Entities.Users.UserInfo,System.String,System.String,System.String)">
335 -----------------------------------------------------------------------------
336 <summary>
337 ChangePasswordQuestionAndAnswer attempts to change the users password Question
338 and PasswordAnswer
339 </summary>
340    <remarks>
341    </remarks>
342    <param name="user">The user to update.</param>
343    <param name="password">The password.</param>
344    <param name="passwordQuestion">The new password question.</param>
345    <param name="passwordAnswer">The new password answer.</param>
346    <returns>A Boolean indicating success or failure.</returns>
347    <history>
348     [cnurse]    02/08/2006    created
349 </history>
350 -----------------------------------------------------------------------------
351
352</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.CreateUser(DotNetNuke.Entities.Users.UserInfo@)">
353 -----------------------------------------------------------------------------
354 <summary>
355 CreateUser persists a User to the Data Store
356 </summary>
357    <remarks>
358    </remarks>
359    <param name="user">The user to persist to the Data Store.</param>
360    <returns>A UserCreateStatus enumeration indicating success or reason for failure.</returns>
361    <history>
362     [cnurse]    12/13/2005    created
363 </history>
364 -----------------------------------------------------------------------------
365
366</member><member name="M:DotNetNuke.Security.Membership.AspNetMembershipProvider.DeleteUser(DotNetNuke.Entities.Users.UserInfo)">
367 -----------------------------------------------------------------------------
368 <summary>
369 DeleteUser deletes a single User from the Data Store
370 </summary>
371    <remarks>
372    </remarks>
373    <param name="user">The user to delete from the Data Store.</param>
374    <returns>A Boolean indicating success or failure.</returns>
375    <history>
376     [cnurse]    12/13/2005    created
377 </history>
378 -----------------------------------------------------------------------------
379