clockwerk-opensim – Blame information for rev 3
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | vero | 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 OpenSimulator 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 | |||
28 | using System.Collections.Generic; |
||
29 | using OpenMetaverse; |
||
30 | using OpenSim.Framework; |
||
31 | using FriendInfo = OpenSim.Services.Interfaces.FriendInfo; |
||
32 | |||
33 | namespace OpenSim.Region.Framework.Interfaces |
||
34 | { |
||
35 | public interface IFriendsModule |
||
36 | { |
||
37 | /// <summary> |
||
38 | /// Are friends cached on this simulator for a particular user? |
||
39 | /// </summary> |
||
40 | /// <param name="userID"></param> |
||
41 | /// <returns></returns> |
||
42 | bool AreFriendsCached(UUID userID); |
||
43 | |||
44 | /// <summary> |
||
45 | /// Get friends from local cache only |
||
46 | /// </summary> |
||
47 | /// <param name="userID"></param> |
||
48 | /// <returns> |
||
49 | /// An empty array if the user has no friends or friends have not been cached. |
||
50 | /// </returns> |
||
51 | FriendInfo[] GetFriendsFromCache(UUID userID); |
||
52 | |||
53 | /// <summary> |
||
54 | /// Add a friendship between two users. |
||
55 | /// </summary> |
||
56 | /// <remarks> |
||
57 | /// Ultimately, it would be more useful to take in a user account here rather than having to have a user |
||
58 | /// present in the scene. |
||
59 | /// </remarks> |
||
60 | /// <param name="client"></param> |
||
61 | /// <param name="friendID"></param> |
||
62 | void AddFriendship(IClientAPI client, UUID friendID); |
||
63 | |||
64 | /// <summary> |
||
65 | /// Remove a friendship between two users. |
||
66 | /// </summary> |
||
67 | /// <remarks> |
||
68 | /// Ultimately, it would be more useful to take in a user account here rather than having to have a user |
||
69 | /// present in the scene. |
||
70 | /// </remarks> |
||
71 | /// <param name="client"></param> |
||
72 | /// <param name="exFriendID"></param> |
||
73 | void RemoveFriendship(IClientAPI client, UUID exFriendID); |
||
74 | |||
75 | /// <summary> |
||
76 | /// Get permissions granted by a friend. |
||
77 | /// </summary> |
||
78 | /// <param name="userID">The user.</param> |
||
79 | /// <param name="friendID">The friend that granted.</param> |
||
80 | /// <returns>The permissions. These come from the FriendRights enum.</returns> |
||
81 | int GetRightsGrantedByFriend(UUID userID, UUID friendID); |
||
82 | |||
83 | /// <summary> |
||
84 | /// Grant permissions for a friend. |
||
85 | /// </summary> |
||
86 | /// <remarks> |
||
87 | /// This includes giving them the ability to see when the user is online and permission to edit the user's |
||
88 | /// objects. |
||
89 | /// Granting lower permissions than the friend currently has will rescind the extra permissions. |
||
90 | /// </remarks> |
||
91 | /// <param name="remoteClient">The user granting the permissions.</param> |
||
92 | /// <param name="friendID">The friend.</param> |
||
93 | /// <param name="perms">These come from the FriendRights enum.</param> |
||
94 | void GrantRights(IClientAPI remoteClient, UUID friendID, int perms); |
||
95 | |||
96 | bool SendFriendsOnlineIfNeeded(IClientAPI client); |
||
97 | } |
||
98 | } |