C# Class OpenSim.Region.CoreModules.Avatar.Friends.FriendsModule

Inheritance: IRegionModule, IFriendsModule
Show file Open project: N3X15/VoxelSim Class Usage Examples

Protected Properties

Property Type Description
m_Friends UserFriendData>.Dictionary
m_FriendsService IFriendsService
m_FriendsSimConnector FriendsSimConnector
m_NeedsListOfFriends HashSet
m_PresenceService IPresenceService
m_Scenes List

Public Methods

Method Description
AddRegion ( Scene scene ) : void
Close ( ) : void
GetFriendPerms ( UUID principalID, UUID friendID ) : uint
Initialise ( IConfigSource config ) : void
LocalFriendshipApproved ( UUID userID, string userName, UUID friendID ) : bool
LocalFriendshipDenied ( UUID userID, string userName, UUID friendID ) : bool
LocalFriendshipOffered ( UUID toID, OpenSim.Framework.GridInstantMessage im ) : bool
LocalFriendshipTerminated ( UUID exfriendID ) : bool
LocalGrantRights ( UUID userID, UUID friendID, int userFlags, int rights ) : bool
LocalStatusNotification ( UUID userID, UUID friendID, bool online ) : bool
LocateClientObject ( UUID agentID ) : IClientAPI

Find the client for a ID
PostInitialise ( ) : void
RegionLoaded ( Scene scene ) : void
RemoveRegion ( Scene scene ) : void
SendFriendsOnlineIfNeeded ( IClientAPI client ) : void

Private Methods

Method Description
ForwardFriendshipOffer ( UUID agentID, UUID friendID, OpenSim.Framework.GridInstantMessage im ) : void
GetClientScene ( UUID agentId ) : Scene

Find the scene for an agent
GetFriends ( UUID agentID ) : OpenMetaverse.FriendInfo[]
GetOnlineFriends ( UUID userID ) : List
OnApproveFriendRequest ( IClientAPI client, UUID agentID, UUID friendID, List callingCardFolders ) : void
OnClientClosed ( UUID agentID, Scene scene ) : void
OnClientLogin ( IClientAPI client ) : void
OnDenyFriendRequest ( IClientAPI client, UUID agentID, UUID friendID, List callingCardFolders ) : void
OnGrantUserRights ( IClientAPI remoteClient, UUID requester, UUID target, int rights ) : void
OnInstantMessage ( IClientAPI client, GridInstantMessage im ) : void
OnMakeRootAgent ( ScenePresence sp ) : void
OnNewClient ( IClientAPI client ) : void
OnTerminateFriendship ( IClientAPI client, UUID agentID, UUID exfriendID ) : void
StatusChange ( UUID agentID, bool online ) : void

Caller beware! Call this only for root agents.
StatusNotify ( OpenSim.Services.Interfaces.FriendInfo friend, UUID userID, bool online ) : void
UpdateFriendsCache ( UUID agentID ) : void

Method Details

AddRegion() public method

public AddRegion ( Scene scene ) : void
scene OpenSim.Region.Framework.Scenes.Scene
return void

Close() public method

public Close ( ) : void
return void

GetFriendPerms() public method

public GetFriendPerms ( UUID principalID, UUID friendID ) : uint
principalID UUID
friendID UUID
return uint

Initialise() public method

public Initialise ( IConfigSource config ) : void
config IConfigSource
return void

LocalFriendshipApproved() public method

public LocalFriendshipApproved ( UUID userID, string userName, UUID friendID ) : bool
userID UUID
userName string
friendID UUID
return bool

LocalFriendshipDenied() public method

public LocalFriendshipDenied ( UUID userID, string userName, UUID friendID ) : bool
userID UUID
userName string
friendID UUID
return bool

LocalFriendshipOffered() public method

public LocalFriendshipOffered ( UUID toID, OpenSim.Framework.GridInstantMessage im ) : bool
toID UUID
im OpenSim.Framework.GridInstantMessage
return bool

LocalFriendshipTerminated() public method

public LocalFriendshipTerminated ( UUID exfriendID ) : bool
exfriendID UUID
return bool

LocalGrantRights() public method

public LocalGrantRights ( UUID userID, UUID friendID, int userFlags, int rights ) : bool
userID UUID
friendID UUID
userFlags int
rights int
return bool

LocalStatusNotification() public method

public LocalStatusNotification ( UUID userID, UUID friendID, bool online ) : bool
userID UUID
friendID UUID
online bool
return bool

LocateClientObject() public method

Find the client for a ID
public LocateClientObject ( UUID agentID ) : IClientAPI
agentID UUID
return IClientAPI

PostInitialise() public method

public PostInitialise ( ) : void
return void

RegionLoaded() public method

public RegionLoaded ( Scene scene ) : void
scene Scene
return void

RemoveRegion() public method

public RemoveRegion ( Scene scene ) : void
scene Scene
return void

SendFriendsOnlineIfNeeded() public method

public SendFriendsOnlineIfNeeded ( IClientAPI client ) : void
client IClientAPI
return void

Property Details

m_Friends protected property

protected Dictionary m_Friends
return UserFriendData>.Dictionary

m_FriendsService protected property

protected IFriendsService m_FriendsService
return IFriendsService

m_FriendsSimConnector protected property

protected FriendsSimConnector m_FriendsSimConnector
return FriendsSimConnector

m_NeedsListOfFriends protected property

protected HashSet m_NeedsListOfFriends
return HashSet

m_PresenceService protected property

protected IPresenceService m_PresenceService
return IPresenceService

m_Scenes protected property

protected List m_Scenes
return List