Inheritance diagram for OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule:

Collaboration diagram for OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule:

Public Member Functions
override void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

override void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

bool	StatusNotify (UUID friendID, UUID userID, bool online)
	Notify the user that the friend's status changed More...

override bool	SendFriendsOnlineIfNeeded (IClientAPI client)

override FriendInfo[]	GetFriendsFromService (IClientAPI client)

override bool	LocalFriendshipOffered (UUID toID, GridInstantMessage im)

Public Member Functions inherited from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule
void	Initialise (IConfigSource config)
	This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

virtual int	GetRightsGrantedByFriend (UUID principalID, UUID friendID)
	Get permissions granted by a friend. More...

IClientAPI	LocateClientObject (UUID agentID)
	Find the client for a ID 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...

void	FindFriend (IClientAPI remoteClient, UUID HunterID, UUID PreyID)

void	GrantRights (IClientAPI remoteClient, UUID friendID, int rights)
	Grant permissions for a friend. More...

bool	LocalFriendshipApproved (UUID userID, string userName, UUID friendID)

bool	LocalFriendshipDenied (UUID userID, string userName, UUID friendID)

bool	LocalFriendshipTerminated (UUID userID, UUID exfriendID)

bool	LocalGrantRights (UUID userID, UUID friendID, int oldRights, int newRights)

bool	LocalStatusNotification (UUID userID, UUID friendID, bool online)

FriendInfo[]	GetFriendsFromCache (UUID userID)
	Get friends from local cache only More...

bool	AreFriendsCached (UUID userID)
	Are friends cached on this simulator for a particular user? More...

Public Member Functions inherited from OpenSim.Services.Interfaces.IFriendsSimConnector
bool	LocalFriendshipApproved (UUID userID, string userName, UUID friendID)

Protected Member Functions
override void	InitModule (IConfigSource config)

override void	OnInstantMessage (IClientAPI client, GridInstantMessage im)

override void	OnApproveFriendRequest (IClientAPI client, UUID friendID, List< UUID > callingCardFolders)

override bool	CacheFriends (IClientAPI client)
	Cache the friends list or increment the refcount for the existing friends list. More...

override void	GetOnlineFriends (UUID userID, List< string > friendList, List< UUID > online)

override void	StatusNotify (List< FriendInfo > friendList, UUID userID, bool online)

override bool	GetAgentInfo (UUID scopeID, string fid, out UUID agentID, out string first, out string last)

override string	GetFriendshipRequesterName (UUID agentID)

override string	FriendshipMessage (string friendID)

override FriendInfo	GetFriend (FriendInfo[] friends, UUID friendID)

override bool	StoreRights (UUID agentID, UUID friendID, int rights)

override void	StoreBackwards (UUID friendID, UUID agentID)

override void	StoreFriendships (UUID agentID, UUID friendID)

override bool	DeleteFriendship (UUID agentID, UUID exfriendID)

override bool	ForwardFriendshipOffer (UUID agentID, UUID friendID, GridInstantMessage im)

Protected Member Functions inherited from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule
void	UpdateLocalCache (UUID userID, UUID friendID, int rights)
	Update local cache only More...

void	RecacheFriends (IClientAPI client)

Protected Attributes
HGFriendsServicesConnector	m_HGFriendsConnector = new HGFriendsServicesConnector()

HGStatusNotifier	m_StatusNotifier

Protected Attributes inherited from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule
bool	m_Enabled = false

List< Scene >	m_Scenes = new List<Scene>()

IPresenceService	m_PresenceService = null

IFriendsService	m_FriendsService = null

FriendsSimConnector	m_FriendsSimConnector

Dictionary< UUID, UserFriendData >	m_Friends = new Dictionary<UUID, UserFriendData>()
	Cache friends lists for users. More...

HashSet< UUID >	m_NeedsToNotifyStatus = new HashSet<UUID>()
	Maintain a record of clients that need to notify about their online status. This only needs to be done on login. Subsequent online/offline friend changes are sent by a different mechanism. More...

HashSet< UUID >	m_NeedsListOfOnlineFriends = new HashSet<UUID>()
	Maintain a record of viewers that need to be sent notifications for friends that are online. This only needs to be done on login. Subsequent online/offline friend changes are sent by a different mechanism. More...

Properties
IUserManagement	UserManagementModule `[get]`

override string	Name `[get]`

Properties inherited from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule
IPresenceService	PresenceService `[get]`

IFriendsService	FriendsService `[get]`

IGridService	GridService `[get]`

IUserAccountService	UserAccountService `[get]`

IScene	Scene `[get]`

virtual string	Name `[get]`

Type	ReplaceableInterface `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Additional Inherited Members
Static Protected Attributes inherited from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule
static readonly FriendInfo[]	EMPTY_FRIENDS = new FriendInfo[0]

Detailed Description

Definition at line 50 of file HGFriendsModule.cs.

Member Function Documentation

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.AddRegion ( Scene scene )

inlinevirtual

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 76 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.CacheFriends ( IClientAPI client )

inlineprotectedvirtual

Cache the friends list or increment the refcount for the existing friends list.

Parameters

client

Returns: Returns true if the list was fetched, false if it wasn't

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 163 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.DeleteFriendship	(	UUID	agentID,
		UUID	exfriendID
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 627 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.ForwardFriendshipOffer	(	UUID	agentID,
		UUID	friendID,
		GridInstantMessage	im
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 732 of file HGFriendsModule.cs.

override string OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.FriendshipMessage ( string friendID )

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 334 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.GetAgentInfo	(	UUID	scopeID,
		string	fid,
		out UUID	agentID,
		out string	first,
		out string	last
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 297 of file HGFriendsModule.cs.

override FriendInfo OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.GetFriend	(	FriendInfo[]	friends,
		UUID	friendID
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 343 of file HGFriendsModule.cs.

override FriendInfo [] OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.GetFriendsFromService ( IClientAPI client )

inlinevirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 353 of file HGFriendsModule.cs.

override string OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.GetFriendshipRequesterName ( UUID agentID )

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 329 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.GetOnlineFriends	(	UUID	userID,
		List< string >	friendList,
		List< UUID >	online
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 227 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.InitModule ( IConfigSource config )

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 93 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.LocalFriendshipOffered	(	UUID	toID,
		GridInstantMessage	im
	)

inlinevirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 786 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.OnApproveFriendRequest	(	IClientAPI	client,
		UUID	friendID,
		List< UUID >	callingCardFolders
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 155 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.OnInstantMessage	(	IClientAPI	client,
		GridInstantMessage	im
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 126 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.RegionLoaded ( Scene scene )

inlinevirtual

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 85 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.SendFriendsOnlineIfNeeded ( IClientAPI client )

inlinevirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 202 of file HGFriendsModule.cs.

bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.StatusNotify	(	UUID	friendID,
		UUID	userID,
		bool	online
	)

inline

Notify the user that the friend's status changed

Parameters

userID	user to be notified
friendID	friend whose status changed
online	status

Returns

Implements OpenSim.Services.Interfaces.IFriendsSimConnector.

Definition at line 119 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.StatusNotify	(	List< FriendInfo >	friendList,
		UUID	userID,
		bool	online
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 255 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.StoreBackwards	(	UUID	friendID,
		UUID	agentID
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 419 of file HGFriendsModule.cs.

override void OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.StoreFriendships	(	UUID	agentID,
		UUID	friendID
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 444 of file HGFriendsModule.cs.

override bool OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.StoreRights	(	UUID	agentID,
		UUID	friendID,
		int	rights
	)

inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule.

Definition at line 378 of file HGFriendsModule.cs.

Member Data Documentation

HGFriendsServicesConnector OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.m_HGFriendsConnector = new HGFriendsServicesConnector()

protected

Definition at line 67 of file HGFriendsModule.cs.

HGStatusNotifier OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.m_StatusNotifier

protected

Definition at line 68 of file HGFriendsModule.cs.

Property Documentation

override string OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.Name

get

Definition at line 72 of file HGFriendsModule.cs.

IUserManagement OpenSim.Region.CoreModules.Avatar.Friends.HGFriendsModule.UserManagementModule

get

Definition at line 58 of file HGFriendsModule.cs.

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

Region/CoreModules/Avatar/Friends/HGFriendsModule.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation