yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds and updates code comments on the UserService

Browse Source
This commit is contained in:
Morten Christensen
2014-08-15 11:13:00 +02:00
parent 7a39751101
commit 1d4d8066ed
2 changed files with 102 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
src/Umbraco.Core/Services/IUserService.cs
View File

@@ -1,5 +1,4 @@
using System.Collections.Generic;
using System.Web;
using Umbraco.Core.Models.Membership;
namespace Umbraco.Core.Services
@@ -12,18 +11,18 @@ namespace Umbraco.Core.Services
/// <summary>
/// This is simply a helper method which essentially just wraps the MembershipProvider's ChangePassword method
/// </summary>
/// <param name="user">The user to save the password for</param>
/// <param name="password"></param>
/// <remarks>
/// This method exists so that Umbraco developers can use one entry point to create/update users if they choose to.
/// </remarks>
/// <param name="user">The user to save the password for</param>
/// <param name="password">The password to save</param>
void SavePassword(IUser user, string password);
/// <summary>
/// To permanently delete the user pass in true, otherwise they will just be disabled
/// Deletes or disables a User
/// </summary>
/// <param name="user"></param>
/// <param name="deletePermanently"></param>
/// <param name="user"><see cref="IUser"/> to delete</param>
/// <param name="deletePermanently"><c>True</c> to permanently delete the user, <c>False</c> to disable the user</param>
void Delete(IUser user, bool deletePermanently);
/// <summary>
@@ -34,79 +33,86 @@ namespace Umbraco.Core.Services
IProfile GetProfileById(int id);
/// <summary>
/// Get profile by username
/// Gets a profile by username
/// </summary>
/// <param name="username"></param>
/// <returns></returns>
/// <param name="username">Username</param>
/// <returns><see cref="IProfile"/></returns>
IProfile GetProfileByUserName(string username);
/// <summary>
/// Get user by Id
/// Gets a user by Id
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
/// <param name="id">Id of the user to retrieve</param>
/// <returns><see cref="IUser"/></returns>
IUser GetUserById(int id);
/// <summary>
/// This is useful when an entire section is removed from config
/// Removes a specific section from all users
/// </summary>
/// <param name="sectionAlias"></param>
/// <remarks>This is useful when an entire section is removed from config</remarks>
/// <param name="sectionAlias">Alias of the section to remove</param>
void DeleteSectionFromAllUsers(string sectionAlias);
/// <summary>
/// Get permissions set for user and specified node ids
/// Get permissions set for a user and optional node ids
/// </summary>
/// <param name="user"></param>
/// <param name="nodeIds">
/// Specifiying nothing will return all user permissions for all nodes
/// </param>
/// <returns></returns>
/// <remarks>If no permissions are found for a particular entity then the user's default permissions will be applied</remarks>
/// <param name="user">User to retrieve permissions for</param>
/// <param name="nodeIds">Specifiying nothing will return all user permissions for all nodes</param>
/// <returns>An enumerable list of <see cref="EntityPermission"/></returns>
IEnumerable<EntityPermission> GetPermissions(IUser user, params int[] nodeIds);
/// <summary>
/// Replaces the same permission set for a single user to any number of entities
/// </summary>
/// <param name="userId"></param>
/// <param name="permissions"></param>
/// <param name="entityIds"></param>
/// <remarks>Note: If no 'entityIds' are specified all permissions will be removed for the specified user.</remarks>
/// <param name="userId">Id of the user</param>
/// <param name="permissions">Permissions as enumerable list of <see cref="char"/></param>
/// <param name="entityIds">Specify the nodes to replace permissions for. If nothing is specified all permissions are removed.</param>
void ReplaceUserPermissions(int userId, IEnumerable<char> permissions, params int[] entityIds);
#region User types
/// <summary>
/// Gets all UserTypes or thosed specified as parameters
/// </summary>
/// <param name="ids">Optional Ids of UserTypes to retrieve</param>
/// <returns>An enumerable list of <see cref="IUserType"/></returns>
IEnumerable<IUserType> GetAllUserTypes(params int[] ids);
/// <summary>
/// Gets an IUserType by its Alias
/// Gets a UserType by its Alias
/// </summary>
/// <param name="alias">Alias of the UserType to retrieve</param>
/// <returns><see cref="IUserType"/></returns>
IUserType GetUserTypeByAlias(string alias);
/// <summary>
/// Gets an IUserType by its Id
/// Gets a UserType by its Id
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
/// <param name="id">Id of the UserType to retrieve</param>
/// <returns><see cref="IUserType"/></returns>
IUserType GetUserTypeById(int id);
/// <summary>
/// Gets an IUserType by its Name
/// Gets a UserType by its Name
/// </summary>
/// <param name="name">Name of the UserType to retrieve</param>
/// <returns><see cref="IUserType"/></returns>
IUserType GetUserTypeByName(string name);
/// <summary>
/// Saves an IUserType
/// Saves a UserType
/// </summary>
/// <param name="userType"></param>
/// <param name="raiseEvents"></param>
/// <param name="userType">UserType to save</param>
/// <param name="raiseEvents">Optional parameter to raise events.
/// Default is <c>True</c> otherwise set to <c>False</c> to not raise events</param>
void SaveUserType(IUserType userType, bool raiseEvents = true);
/// <summary>
/// Deletes an IUserType
/// Deletes a UserType
/// </summary>
/// <param name="userType"></param>
/// <param name="userType">UserType to delete</param>
void DeleteUserType(IUserType userType);
#endregion