aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Communications/IUserAdminService.cs
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Framework/Communications/IUserAdminService.cs')
-rw-r--r--OpenSim/Framework/Communications/IUserAdminService.cs71
1 files changed, 71 insertions, 0 deletions
diff --git a/OpenSim/Framework/Communications/IUserAdminService.cs b/OpenSim/Framework/Communications/IUserAdminService.cs
new file mode 100644
index 0000000..3b7ba6e
--- /dev/null
+++ b/OpenSim/Framework/Communications/IUserAdminService.cs
@@ -0,0 +1,71 @@
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
28using OpenMetaverse;
29
30namespace OpenSim.Framework.Communications
31{
32 /// <summary>
33 /// Interface for the service for administrating users
34 /// </summary>
35 public interface IUserAdminService
36 {
37 /// <summary>
38 /// Add a new user
39 /// </summary>
40 /// <param name="firstName">The first name</param>
41 /// <param name="lastName">The last name</param>
42 /// <param name="pass">password of avatar</param>
43 /// <param name="email">email of user</param>
44 /// <param name="regX">region X</param>
45 /// <param name="regY">region Y</param>
46 /// <returns>The UUID of the created user profile. On failure, returns UUID.Zero</returns>
47 UUID AddUser(string firstName, string lastName, string pass, string email, uint regX, uint regY);
48
49 /// <summary>
50 /// Add a new user with a specified UUID. SHOULD ONLY BE USED in very special circumstances from modules!
51 /// </summary>
52 /// <param name="firstName">The first name</param>
53 /// <param name="lastName">The last name</param>
54 /// <param name="pass">password of avatar</param>
55 /// <param name="email">email of user</param>
56 /// <param name="regX">region X</param>
57 /// <param name="regY">region Y</param>
58 /// <param name="setUUID">The set UUID</param>
59 /// <returns>The UUID of the created user profile. On failure, returns UUID.Zero</returns>
60 UUID AddUser(string firstName, string lastName, string pass, string email, uint regX, uint regY, UUID setUUID);
61
62 /// <summary>
63 /// Reset a user password
64 /// </summary>
65 /// <param name="firstName"></param>
66 /// <param name="lastName"></param>
67 /// <param name="newPassword"></param>
68 /// <returns>true if the update was successful, false otherwise</returns>
69 bool ResetUserPassword(string firstName, string lastName, string newPassword);
70 }
71}