Improved method doc for AddFriend() - it actually does set up a two-way relationship.

Rename IFriendsModule.AddFriend() to AddFriendship()
This commit is contained in:
Justin Clark-Casey (justincc)
2011-11-14 20:31:16 +00:00
parent a64def8b73
commit e5ff7f389b
3 changed files with 7 additions and 9 deletions

View File

@@ -34,18 +34,15 @@ namespace OpenSim.Region.Framework.Interfaces
public interface IFriendsModule
{
/// <summary>
/// Add a friend for the given user.
/// Add a friendship between two users.
/// </summary>
/// <remarks>
/// This is a one-way friendship. To make a two way friendship you will need to call this again with the
/// client and friend reversed.
///
/// Ultimately, it would be more useful to take in a user account here rather than having to have a user
/// present in the scene.
/// </remarks>
/// <param name="client"></param>
/// <param name="friendID"></param>
void AddFriend(IClientAPI client, UUID friendID);
void AddFriendship(IClientAPI client, UUID friendID);
uint GetFriendPerms(UUID PrincipalID, UUID FriendID);
bool SendFriendsOnlineIfNeeded(IClientAPI client);