OpenSim.Region.Framework.Interfaces.IFriendsModule Interface Reference

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IFriendsModule:

Public Member Functions
bool	AreFriendsCached (UUID userID)
	Are friends cached on this simulator for a particular user? More...
FriendInfo[]	GetFriendsFromCache (UUID userID)
	Get friends from local cache only More...
void	AddFriendship (IClientAPI client, UUID friendID)
	Add a friendship between two users. More...
void	RemoveFriendship (IClientAPI client, UUID exFriendID)
	Remove a friendship between two users. More...
int	GetRightsGrantedByFriend (UUID userID, UUID friendID)
	Get permissions granted by a friend. More...
void	GrantRights (IClientAPI remoteClient, UUID friendID, int perms)
	Grant permissions for a friend. More...
bool	SendFriendsOnlineIfNeeded (IClientAPI client)

Detailed Description

Definition at line 35 of file IFriendsModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IFriendsModule.AddFriendship	(	IClientAPI	client,
		UUID	friendID
	)

Add a friendship between two users.

Ultimately, it would be more useful to take in a user account here rather than having to have a user present in the scene.

Parameters

client
friendID

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

bool OpenSim.Region.Framework.Interfaces.IFriendsModule.AreFriendsCached

(

UUID

userID

)

Are friends cached on this simulator for a particular user?

Parameters

userID

Returns

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

FriendInfo [] OpenSim.Region.Framework.Interfaces.IFriendsModule.GetFriendsFromCache

(

UUID

userID

)

Get friends from local cache only

Parameters

userID

Returns

An empty array if the user has no friends or friends have not been cached.

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

int OpenSim.Region.Framework.Interfaces.IFriendsModule.GetRightsGrantedByFriend	(	UUID	userID,
		UUID	friendID
	)

Get permissions granted by a friend.

Parameters

userID	The user.
friendID	The friend that granted.

Returns

The permissions. These come from the FriendRights enum.

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

void OpenSim.Region.Framework.Interfaces.IFriendsModule.GrantRights	(	IClientAPI	remoteClient,
		UUID	friendID,
		int	perms
	)

Grant permissions for a friend.

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.

Parameters

remoteClient	The user granting the permissions.
friendID	The friend.
perms	These come from the FriendRights enum.

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

void OpenSim.Region.Framework.Interfaces.IFriendsModule.RemoveFriendship	(	IClientAPI	client,
		UUID	exFriendID
	)

Remove a friendship between two users.

Ultimately, it would be more useful to take in a user account here rather than having to have a user present in the scene.

Parameters

client
exFriendID

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

bool OpenSim.Region.Framework.Interfaces.IFriendsModule.SendFriendsOnlineIfNeeded

(

IClientAPI

client

)

Implemented in OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule, and OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.

---

The documentation for this interface was generated from the following file:

• Region/Framework/Interfaces/IFriendsModule.cs