|
OpenSim
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
|
OpenSim
|
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... | |
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... | |
Definition at line 46 of file GroupsMessagingModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 124 of file GroupsMessagingModule.cs.
|
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 189 of file GroupsMessagingModule.cs.
|
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.
| source | A IConfigSource |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 84 of file GroupsMessagingModule.cs.
|
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 222 of file GroupsMessagingModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 140 of file GroupsMessagingModule.cs.
|
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.
| scene | A Scene |
Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.
Definition at line 179 of file GroupsMessagingModule.cs.
|
inline |
Send a message to each member of a group whose chat session is active.
| im | The 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
| groupID |
Implements OpenSim.Region.Framework.Interfaces.IGroupsMessagingModule.
Definition at line 269 of file GroupsMessagingModule.cs.
|
inline |
Send a message to all the members of a group that fulfill a condition.
| im | The 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
| groupID | |
| sendingAgentForGroupCalls | The requesting agent to use when querying the groups service. Sometimes this is different from im.fromAgentID, with group notices, for example. |
| sendCondition | The 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 274 of file GroupsMessagingModule.cs.
|
inline |
Not really needed, but does confirm that the group exists.
Implements OpenSim.Region.Framework.Interfaces.IGroupsMessagingModule.
Definition at line 252 of file GroupsMessagingModule.cs.
|
get |
Definition at line 214 of file GroupsMessagingModule.cs.
|
get |
Definition at line 209 of file GroupsMessagingModule.cs.
1.8.6