IUserAdminService.cs 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSim Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using OpenMetaverse;
  28. namespace OpenSim.Framework.Communications
  29. {
  30. /// <summary>
  31. /// Interface for the service for administrating users
  32. /// </summary>
  33. public interface IUserAdminService
  34. {
  35. /// <summary>
  36. /// Add a new user
  37. /// </summary>
  38. /// <param name="firstName">The first name</param>
  39. /// <param name="lastName">The last name</param>
  40. /// <param name="pass">password of avatar</param>
  41. /// <param name="email">email of user</param>
  42. /// <param name="regX">region X</param>
  43. /// <param name="regY">region Y</param>
  44. /// <returns>The UUID of the created user profile. On failure, returns UUID.Zero</returns>
  45. UUID AddUser(string firstName, string lastName, string pass, string email, uint regX, uint regY);
  46. /// <summary>
  47. /// Add a new user with a specified UUID. SHOULD ONLY BE USED in very special circumstances from modules!
  48. /// </summary>
  49. /// <param name="firstName">The first name</param>
  50. /// <param name="lastName">The last name</param>
  51. /// <param name="pass">password of avatar</param>
  52. /// <param name="email">email of user</param>
  53. /// <param name="regX">region X</param>
  54. /// <param name="regY">region Y</param>
  55. /// <param name="setUUID">The set UUID</param>
  56. /// <returns>The UUID of the created user profile. On failure, returns UUID.Zero</returns>
  57. UUID AddUser(string firstName, string lastName, string pass, string email, uint regX, uint regY, UUID setUUID);
  58. /// <summary>
  59. /// Reset a user password
  60. /// </summary>
  61. /// <param name="firstName"></param>
  62. /// <param name="lastName"></param>
  63. /// <param name="newPassword"></param>
  64. /// <returns>true if the update was successful, false otherwise</returns>
  65. bool ResetUserPassword(string firstName, string lastName, string newPassword);
  66. }
  67. }