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

		            
  1<?xml version="1.0"?>
  2<doc>
  3<assembly>
  4<name>
  5DotNetNuke.Provider.DNNProvider
  6</name>
  7</assembly>
  8<members>
  9<member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.CreateRole(System.Int32,DotNetNuke.Security.Roles.RoleInfo@)">
 10 -----------------------------------------------------------------------------
 11 <summary>
 12 CreateRole persists a Role to the Data Store
 13 </summary>
 14    <remarks>
 15    </remarks>
 16    <param name="portalId">Id of the portal</param>
 17    <param name="role">The role to persist to the Data Store.</param>
 18    <returns>A Boolean indicating success or failure.</returns>
 19    <history>
 20     [cnurse]    03/28/2006    created
 21 </history>
 22 -----------------------------------------------------------------------------
 23
 24</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.DeleteRole(System.Int32,DotNetNuke.Security.Roles.RoleInfo@)">
 25 -----------------------------------------------------------------------------
 26 <summary>
 27 DeleteRole deletes a Role from the Data Store
 28 </summary>
 29    <param name="portalId">Id of the portal</param>
 30    <param name="role">The role to delete from the Data Store.</param>
 31    <history>
 32     [cnurse]    03/28/2006    created
 33 </history>
 34 -----------------------------------------------------------------------------
 35
 36</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRole(System.Int32,System.Int32)">
 37 -----------------------------------------------------------------------------
 38 <summary>
 39 GetRole gets a role from the Data Store
 40 </summary>
 41    <remarks>This overload gets the role by its ID</remarks>
 42    <param name="portalId">Id of the portal</param>
 43    <param name="roleId">The Id of the role to retrieve.</param>
 44    <returns>A RoleInfo object</returns>
 45    <history>
 46     [cnurse]    03/28/2006    created
 47 </history>
 48 -----------------------------------------------------------------------------
 49
 50</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRole(System.Int32,System.String)">
 51 -----------------------------------------------------------------------------
 52 <summary>
 53 GetRole gets a role from the Data Store
 54 </summary>
 55    <remarks>This overload gets the role by its name</remarks>
 56    <param name="portalId">Id of the portal</param>
 57    <param name="roleName">The name of the role to retrieve.</param>
 58    <returns>A RoleInfo object</returns>
 59    <history>
 60     [cnurse]    03/28/2006    created
 61 </history>
 62 -----------------------------------------------------------------------------
 63
 64</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRoleNames(System.Int32)">
 65 -----------------------------------------------------------------------------
 66 <summary>
 67 GetRoleNames gets an array of roles for a portal
 68 </summary>
 69    <param name="portalId">Id of the portal</param>
 70    <returns>A RoleInfo object</returns>
 71    <history>
 72     [cnurse]    03/28/2006    created
 73 </history>
 74 -----------------------------------------------------------------------------
 75
 76</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRoleNames(System.Int32,System.Int32)">
 77 -----------------------------------------------------------------------------
 78 <summary>
 79 GetRoleNames gets an array of roles
 80 </summary>
 81    <param name="portalId">Id of the portal</param>
 82    <param name="userId">The Id of the user whose roles are required. (If -1 then all
 83 rolenames in a portal are retrieved.</param>
 84    <returns>A RoleInfo object</returns>
 85    <history>
 86     [cnurse]    03/28/2006    created
 87 </history>
 88 -----------------------------------------------------------------------------
 89
 90</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRoles(System.Int32)">
 91 -----------------------------------------------------------------------------
 92 <summary>
 93 Get the roles for a portal
 94 </summary>
 95    <param name="portalId">Id of the portal (If -1 all roles for all portals are 
 96 retrieved.</param>
 97    <returns>An ArrayList of RoleInfo objects</returns>
 98    <history>
 99     [cnurse]    03/28/2006    created
100 </history>
101 -----------------------------------------------------------------------------
102
103</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRolesByGroup(System.Int32,System.Int32)">
104 -----------------------------------------------------------------------------
105 <summary>
106 Get the roles for a Role Group
107 </summary>
108    <param name="portalId">Id of the portal</param>
109    <param name="roleGroupId">Id of the Role Group (If -1 all roles for the portal are
110 retrieved).</param>
111    <returns>An ArrayList of RoleInfo objects</returns>
112    <history>
113     [cnurse]    03/28/2006    created
114 </history>
115 -----------------------------------------------------------------------------
116
117</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.UpdateRole(DotNetNuke.Security.Roles.RoleInfo)">
118 -----------------------------------------------------------------------------
119 <summary>
120 Update a role
121 </summary>
122    <param name="role">The role to update</param>
123    <history>
124     [cnurse]    03/28/2006    created
125 </history>
126 -----------------------------------------------------------------------------
127
128</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.CreateRoleGroup(DotNetNuke.Security.Roles.RoleGroupInfo)">
129 -----------------------------------------------------------------------------
130 <summary>
131 CreateRoleGroup persists a RoleGroup to the Data Store
132 </summary>
133    <remarks>
134    </remarks>
135    <param name="roleGroup">The RoleGroup to persist to the Data Store.</param>
136    <returns>The Id of the new role.</returns>
137    <history>
138     [cnurse]    03/28/2006    created
139 </history>
140 -----------------------------------------------------------------------------
141
142</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.DeleteRoleGroup(DotNetNuke.Security.Roles.RoleGroupInfo)">
143 -----------------------------------------------------------------------------
144 <summary>
145 DeleteRoleGroup deletes a RoleGroup from the Data Store
146 </summary>
147    <param name="roleGroup">The RoleGroup to delete from the Data Store.</param>
148    <history>
149     [cnurse]    03/28/2006    created
150 </history>
151 -----------------------------------------------------------------------------
152
153</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRoleGroup(System.Int32,System.Int32)">
154 -----------------------------------------------------------------------------
155 <summary>
156 GetRoleGroup gets a RoleGroup from the Data Store
157 </summary>
158    <param name="portalId">Id of the portal</param>
159    <param name="roleGroupId">The Id of the RoleGroup to retrieve.</param>
160    <returns>A RoleGroupInfo object</returns>
161    <history>
162     [cnurse]    03/28/2006    created
163 </history>
164 -----------------------------------------------------------------------------
165
166</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetRoleGroups(System.Int32)">
167 -----------------------------------------------------------------------------
168 <summary>
169 Get the RoleGroups for a portal
170 </summary>
171    <param name="portalId">Id of the portal.</param>
172    <returns>An ArrayList of RoleGroupInfo objects</returns>
173    <history>
174     [cnurse]    03/28/2006    created
175 </history>
176 -----------------------------------------------------------------------------
177
178</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.UpdateRoleGroup(DotNetNuke.Security.Roles.RoleGroupInfo)">
179 -----------------------------------------------------------------------------
180 <summary>
181 Update a RoleGroup
182 </summary>
183    <param name="roleGroup">The RoleGroup to update</param>
184    <history>
185     [cnurse]    03/28/2006    created
186 </history>
187 -----------------------------------------------------------------------------
188
189</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.AddDNNUserRole(DotNetNuke.Entities.Users.UserRoleInfo)">
190 -----------------------------------------------------------------------------
191 <summary>
192 adds a DNN UserRole
193 </summary>
194    <param name="userRole">The role to add the user to.</param>
195    <history>
196     [cnurse]    03/28/2006    created
197 </history>
198 -----------------------------------------------------------------------------
199
200</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.AddUserToRole(System.Int32,DotNetNuke.Entities.Users.UserInfo,DotNetNuke.Entities.Users.UserRoleInfo)">
201 -----------------------------------------------------------------------------
202 <summary>
203 AddUserToRole adds a User to a Role
204 </summary>
205    <remarks>
206    </remarks>
207    <param name="portalId">Id of the portal</param>
208    <param name="user">The user to add.</param>
209    <param name="userRole">The role to add the user to.</param>
210    <returns>A Boolean indicating success or failure.</returns>
211    <history>
212     [cnurse]    03/28/2006    created
213 </history>
214 -----------------------------------------------------------------------------
215
216</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetUserRole(System.Int32,System.Int32,System.Int32)">
217 -----------------------------------------------------------------------------
218 <summary>
219 GetUserRole gets a User/Role object from the Data Store
220 </summary>
221    <remarks>
222    </remarks>
223    <param name="portalId">Id of the portal</param>
224    <param name="userId">The Id of the User</param>
225    <param name="roleId">The Id of the Role.</param>
226    <returns>The UserRoleInfo object</returns>
227    <history>
228     [cnurse]    03/28/2006    created
229 </history>
230 -----------------------------------------------------------------------------
231
232</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetUserRoles(System.Int32,System.Int32,System.Boolean)">
233 -----------------------------------------------------------------------------
234 <summary>
235 GetUserRoles gets a collection of User/Role objects from the Data Store
236 </summary>
237    <remarks>
238    </remarks>
239    <param name="portalId">Id of the portal</param>
240    <param name="userId">The user to fetch roles for</param>
241    <returns>An ArrayList of UserRoleInfo objects</returns>
242    <history>
243     [cnurse]    03/28/2006    created
244 </history>
245 -----------------------------------------------------------------------------
246
247</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetUserRoles(System.Int32,System.String,System.String)">
248 -----------------------------------------------------------------------------
249 <summary>
250 GetUserRoles gets a collection of User/Role objects from the Data Store
251 </summary>
252    <remarks>
253    </remarks>
254    <param name="portalId">Id of the portal</param>
255    <param name="userName">The user to fetch roles for</param>
256    <param name="roleName">The role to fetch users for</param>
257    <returns>An ArrayList of UserRoleInfo objects</returns>
258    <history>
259     [cnurse]    03/28/2006    created
260 </history>
261 -----------------------------------------------------------------------------
262
263</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetUserRolesByRoleName(System.Int32,System.String)">
264 -----------------------------------------------------------------------------
265 <summary>
266 Get the users in a role (as UserRole objects)
267 </summary>
268    <param name="portalId">Id of the portal (If -1 all roles for all portals are 
269 retrieved.</param>
270    <param name="roleName">The role to fetch users for</param>
271    <returns>An ArrayList of UserRoleInfo objects</returns>
272    <history>
273     [cnurse]    03/28/2006    created
274 </history>
275 -----------------------------------------------------------------------------
276
277</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.GetUsersByRoleName(System.Int32,System.String)">
278 -----------------------------------------------------------------------------
279 <summary>
280 Get the users in a role (as User objects)
281 </summary>
282    <param name="portalId">Id of the portal (If -1 all roles for all portals are 
283 retrieved.</param>
284    <param name="roleName">The role to fetch users for</param>
285    <returns>An ArrayList of UserInfo objects</returns>
286    <history>
287     [cnurse]    03/28/2006    created
288 </history>
289 -----------------------------------------------------------------------------
290
291</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.RemoveUserFromRole(System.Int32,DotNetNuke.Entities.Users.UserInfo,DotNetNuke.Entities.Users.UserRoleInfo)">
292 -----------------------------------------------------------------------------
293 <summary>
294 Remove a User from a Role
295 </summary>
296    <remarks>
297    </remarks>
298    <param name="portalId">Id of the portal</param>
299    <param name="user">The user to remove.</param>
300    <param name="userRole">The role to remove the user from.</param>
301    <history>
302     [cnurse]    03/28/2006    created
303 </history>
304 -----------------------------------------------------------------------------
305
306</member><member name="M:DotNetNuke.Security.Membership.DNNRoleProvider.UpdateUserRole(DotNetNuke.Entities.Users.UserRoleInfo)">
307 -----------------------------------------------------------------------------
308 <summary>
309 Updates a User/Role
310 </summary>
311    <param name="userRole">The User/Role to update</param>
312    <history>
313     [cnurse]    12/15/2005    created
314 </history>
315 -----------------------------------------------------------------------------
316
317</member><member name="T:DotNetNuke.Security.Membership.DNNRoleProvider">
318 -----------------------------------------------------------------------------
319 Project:    DotNetNuke
320 Namespace:  DotNetNuke.Security.Membership
321 Class:      DNNRoleProvider
322 -----------------------------------------------------------------------------
323 <summary>
324 The DNNRoleProvider overrides the default MembershipProvider to provide
325 a purely DNN Membership Component implementation
326 </summary>
327    <remarks>
328    </remarks>
329    <history>
330     [cnurse]    03/28/2006    created
331 </history>
332 -----------------------------------------------------------------------------
333
334</member><member name="P:DotNetNuke.Security.Profile.DNNProfileProvider.CanEditProviderProperties">
335 -----------------------------------------------------------------------------
336 <summary>
337 Gets whether the Provider Properties can be edited
338 </summary>
339    <returns>A Boolean</returns>
340    <history>
341     [cnurse]    03/29/2006    Created
342 </history>
343 -----------------------------------------------------------------------------
344
345</member><member name="M:DotNetNuke.Security.Profile.DNNProfileProvider.GetUserProfile(DotNetNuke.Entities.Users.UserInfo@)">
346 -----------------------------------------------------------------------------
347 <summary>
348 GetUserProfile retrieves the UserProfile information from the Data Store
349 </summary>
350    <remarks>
351    </remarks>
352    <param name="user">The user whose Profile information we are retrieving.</param>
353    <history>
354     [cnurse]    03/29/2006    Created
355 </history>
356 -----------------------------------------------------------------------------
357
358</member><member name="M:DotNetNuke.Security.Profile.DNNProfileProvider.UpdateUserProfile(DotNetNuke.Entities.Users.UserInfo)">
359 -----------------------------------------------------------------------------
360 <summary>
361 UpdateUserProfile persists a user's Profile to the Data Store
362 </summary>
363    <remarks>
364    </remarks>
365    <param name="user">The user to persist to the Data Store.</param>
366    <history>
367     [cnurse]    03/29/2006    Created
368 </history>
369 -----------------------------------------------------------------------------
370
371</member><member name="T:DotNetNuke.Security.Profile.DNNProfileProvider">
372 -----------------------------------------------------------------------------
373 Project:    DotNetNuke
374 Namespace:  DotNetNuke.Security.Profile
375 Class:      DNNProfileProvider
376 -----------------------------------------------------------------------------
377 <summary>
378 The DNNProfileProvider overrides the default ProfileProvider to provide
379 a purely DotNetNuke implementation
380 </summary>
381    <remarks>
382    </remarks>
383    <history>
384