OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
OpenSim.Groups.GroupsMessagingModule Class Reference
Inheritance diagram for OpenSim.Groups.GroupsMessagingModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Groups.GroupsMessagingModule:
Collaboration graph
[legend]

Public Member Functions

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 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...
 
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...
 
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...
 
void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
bool StartGroupChatSession (UUID agentID, UUID groupID)
 Not really needed, but does confirm that the group exists. More...
 
void SendMessageToGroup (GridInstantMessage im, UUID groupID)
 Send a message to each member of a group whose chat session is active. More...
 
void SendMessageToGroup (GridInstantMessage im, UUID groupID, UUID sendingAgentForGroupCalls, Func< GroupMembersData, bool > sendCondition)
 Send a message to all the members of a group that fulfill a condition. More...
 
void ResetAgentGroupChatSessions (string agentID)
 
bool hasAgentBeenInvitedToGroupChatSession (string agentID, UUID groupID)
 
bool hasAgentDroppedGroupChatSession (string agentID, UUID groupID)
 
void AgentDroppedFromGroupChatSession (string agentID, UUID groupID)
 
void AgentInvitedToGroupChatSession (string agentID, UUID groupID)
 

Properties

Type ReplaceableInterface [get]
 
string Name [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...
 

Detailed Description

Definition at line 47 of file GroupsMessagingModule.cs.

Member Function Documentation

void OpenSim.Groups.GroupsMessagingModule.AddRegion ( Scene  scene)
inline

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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 130 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.AgentDroppedFromGroupChatSession ( string  agentID,
UUID  groupID 
)
inline

Definition at line 808 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.AgentInvitedToGroupChatSession ( string  agentID,
UUID  groupID 
)
inline

Definition at line 820 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.Close ( )
inline

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

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 208 of file GroupsMessagingModule.cs.

bool OpenSim.Groups.GroupsMessagingModule.hasAgentBeenInvitedToGroupChatSession ( string  agentID,
UUID  groupID 
)
inline

Definition at line 793 of file GroupsMessagingModule.cs.

bool OpenSim.Groups.GroupsMessagingModule.hasAgentDroppedGroupChatSession ( string  agentID,
UUID  groupID 
)
inline

Definition at line 800 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.Initialise ( IConfigSource  source)
inline

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.

Parameters
sourceA IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 88 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.PostInitialise ( )
inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 231 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.RegionLoaded ( Scene  scene)
inline

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
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 153 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.RemoveRegion ( Scene  scene)
inline

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.

Parameters
sceneA Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 194 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.ResetAgentGroupChatSessions ( string  agentID)
inline

Definition at line 784 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.SendMessageToGroup ( GridInstantMessage  im,
UUID  groupID 
)
inline

Send a message to each member of a group whose chat session is active.

Parameters
imThe message itself. The fields that must be populated are

imSessionID - Populate this with the group ID (session ID and group ID are currently identical) fromAgentName - Populate this with whatever arbitrary name you want to show up in the chat dialog message - The message itself dialog - This must be (byte)InstantMessageDialog.SessionSend

Parameters
groupID

Implements OpenSim.Region.Framework.Interfaces.IGroupsMessagingModule.

Definition at line 278 of file GroupsMessagingModule.cs.

void OpenSim.Groups.GroupsMessagingModule.SendMessageToGroup ( GridInstantMessage  im,
UUID  groupID,
UUID  sendingAgentForGroupCalls,
Func< GroupMembersData, bool >  sendCondition 
)
inline

Send a message to all the members of a group that fulfill a condition.

Parameters
imThe message itself. The fields that must be populated are

imSessionID - Populate this with the group ID (session ID and group ID are currently identical) fromAgentName - Populate this with whatever arbitrary name you want to show up in the chat dialog message - The message itself dialog - This must be (byte)InstantMessageDialog.SessionSend

Parameters
groupID
sendingAgentForGroupCallsThe requesting agent to use when querying the groups service. Sometimes this is different from im.fromAgentID, with group notices, for example.
sendConditionThe condition that must be met by a member for the message to be sent. If null then the message is sent if the chat session is active.

Implements OpenSim.Region.Framework.Interfaces.IGroupsMessagingModule.

Definition at line 283 of file GroupsMessagingModule.cs.

bool OpenSim.Groups.GroupsMessagingModule.StartGroupChatSession ( UUID  agentID,
UUID  groupID 
)
inline

Not really needed, but does confirm that the group exists.

Implements OpenSim.Region.Framework.Interfaces.IGroupsMessagingModule.

Definition at line 261 of file GroupsMessagingModule.cs.

Property Documentation

string OpenSim.Groups.GroupsMessagingModule.Name
get

Definition at line 227 of file GroupsMessagingModule.cs.

Type OpenSim.Groups.GroupsMessagingModule.ReplaceableInterface
get

Definition at line 222 of file GroupsMessagingModule.cs.


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