From 59157d9d63c0e038ca0a619bfae1be3ed6f77677 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Fri, 30 Mar 2012 00:40:19 +0100
Subject: Add simple login test with online friends.  Add
 IFriendsModule.GrantRights() for granting rights via a module call.

Rename IFriendsModule.GetFriendPerms() -> GetRightsGrantedByFriend() to be more self-documenting and consistent with friends module terminology.
Add some method doc.
---
 .../Region/Framework/Interfaces/IFriendsModule.cs  | 24 ++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

(limited to 'OpenSim/Region/Framework')

diff --git a/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs b/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
index 061799e..10bef1e 100644
--- a/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
+++ b/OpenSim/Region/Framework/Interfaces/IFriendsModule.cs
@@ -55,7 +55,27 @@ namespace OpenSim.Region.Framework.Interfaces
         /// <param name="exFriendID"></param>
         void RemoveFriendship(IClientAPI client, UUID exFriendID);
 
-        uint GetFriendPerms(UUID PrincipalID, UUID FriendID);
+        /// <summary>
+        /// Get permissions granted by a friend.
+        /// </summary>
+        /// <param name="PrincipalID">The user.</param>
+        /// <param name="FriendID">The friend that granted.</param>
+        /// <returns>The permissions.  These come from the FriendRights enum.</returns>
+        int GetRightsGrantedByFriend(UUID PrincipalID, UUID FriendID);
+
+        /// <summary>
+        /// Grant permissions for a friend.
+        /// </summary>
+        /// <remarks>
+        /// This includes giving them the ability to see when the user is online and permission to edit the user's
+        /// objects.
+        /// Granting lower permissions than the friend currently has will rescind the extra permissions.
+        /// </remarks>
+        /// <param name="remoteClient">The user granting the permissions.</param>
+        /// <param name="friendID">The friend.</param>
+        /// <param name="perms">These come from the FriendRights enum.</param>
+        void GrantRights(IClientAPI remoteClient, UUID friendID, int perms);
+
         bool SendFriendsOnlineIfNeeded(IClientAPI client);
     }
-}
+}
\ No newline at end of file
-- 
cgit v1.1