OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | Events | List of all members
OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule Class Reference
Inheritance diagram for OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule:
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...
 
GroupRecord GetGroupRecord (UUID GroupID)
 Get a group More...
 
GroupRecord GetGroupRecord (string name)
 Get a group More...
 
void ActivateGroup (IClientAPI remoteClient, UUID groupID)
 
List< GroupTitlesData > GroupTitlesRequest (IClientAPI remoteClient, UUID groupID)
 Get the Role Titles for an Agent, for a specific group More...
 
List< GroupMembersData > GroupMembersRequest (IClientAPI remoteClient, UUID groupID)
 
List< GroupRolesData > GroupRoleDataRequest (IClientAPI remoteClient, UUID groupID)
 
List< GroupRoleMembersData > GroupRoleMembersRequest (IClientAPI remoteClient, UUID groupID)
 
GroupProfileData GroupProfileRequest (IClientAPI remoteClient, UUID groupID)
 
GroupMembershipData[] GetMembershipData (UUID agentID)
 
GroupMembershipData GetMembershipData (UUID groupID, UUID agentID)
 
void UpdateGroupInfo (IClientAPI remoteClient, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish)
 
void SetGroupAcceptNotices (IClientAPI remoteClient, UUID groupID, bool acceptNotices, bool listInProfile)
 
UUID CreateGroup (IClientAPI remoteClient, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish)
 Create a group More...
 
GroupNoticeData[] GroupNoticesListRequest (IClientAPI remoteClient, UUID groupID)
 
string GetGroupTitle (UUID avatarID)
 Get the title of the agent's current role. More...
 
void GroupTitleUpdate (IClientAPI remoteClient, UUID groupID, UUID titleRoleID)
 Change the current Active Group Role for Agent More...
 
void GroupRoleUpdate (IClientAPI remoteClient, UUID groupID, UUID roleID, string name, string description, string title, ulong powers, byte updateType)
 
void GroupRoleChanges (IClientAPI remoteClient, UUID groupID, UUID roleID, UUID memberID, uint changes)
 
void GroupNoticeRequest (IClientAPI remoteClient, UUID groupNoticeID)
 
GridInstantMessage CreateGroupNoticeIM (UUID agentID, UUID groupNoticeID, byte dialog)
 
void JoinGroupRequest (IClientAPI remoteClient, UUID groupID)
 
void LeaveGroupRequest (IClientAPI remoteClient, UUID groupID)
 
void EjectGroupMemberRequest (IClientAPI remoteClient, UUID groupID, UUID ejecteeID)
 
void EjectGroupMember (IClientAPI remoteClient, UUID agentID, UUID groupID, UUID ejecteeID)
 
void InviteGroupRequest (IClientAPI remoteClient, UUID groupID, UUID invitedAgentID, UUID roleID)
 
void InviteGroup (IClientAPI remoteClient, UUID agentID, UUID groupID, UUID invitedAgentID, UUID roleID)
 
List< DirGroupsReplyData > FindGroups (IClientAPI remoteClient, string query)
 
void SendAgentGroupDataUpdate (IClientAPI remoteClient)
 
void NotifyChange (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...
 

Events

NewGroupNotice OnNewGroupNotice
 
- Events inherited from OpenSim.Region.Framework.Interfaces.IGroupsModule
NewGroupNotice OnNewGroupNotice
 

Detailed Description

Definition at line 47 of file GroupsModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.ActivateGroup ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 694 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 125 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 228 of file GroupsModule.cs.

UUID OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.CreateGroup ( IClientAPI  remoteClient,
string  name,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish 
)
inline

Create a group

Parameters
remoteClient
name
charter
showInList
insigniaID
membershipFee
openEnrollment
allowPublish
maturePublish
Returns
The UUID of the created group

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 845 of file GroupsModule.cs.

Here is the call graph for this function:

GridInstantMessage OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.CreateGroupNoticeIM ( UUID  agentID,
UUID  groupNoticeID,
byte  dialog 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1009 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.EjectGroupMember ( IClientAPI  remoteClient,
UUID  agentID,
UUID  groupID,
UUID  ejecteeID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1104 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.EjectGroupMemberRequest ( IClientAPI  remoteClient,
UUID  groupID,
UUID  ejecteeID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1099 of file GroupsModule.cs.

List<DirGroupsReplyData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.FindGroups ( IClientAPI  remoteClient,
string  query 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1294 of file GroupsModule.cs.

GroupRecord OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GetGroupRecord ( UUID  GroupID)
inline

Get a group

Parameters
GroupIDID of the group
Returns
The group's data. Null if there is no such group.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 684 of file GroupsModule.cs.

GroupRecord OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GetGroupRecord ( string  name)
inline

Get a group

Parameters
nameName of the group
Returns
The group's data. Null if there is no such group.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 689 of file GroupsModule.cs.

string OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GetGroupTitle ( UUID  avatarID)
inline

Get the title of the agent's current role.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 903 of file GroupsModule.cs.

GroupMembershipData [] OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GetMembershipData ( UUID  agentID)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 812 of file GroupsModule.cs.

GroupMembershipData OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GetMembershipData ( UUID  groupID,
UUID  agentID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 819 of file GroupsModule.cs.

List<GroupMembersData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupMembersRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 732 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupNoticeRequest ( IClientAPI  remoteClient,
UUID  groupNoticeID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 995 of file GroupsModule.cs.

GroupNoticeData [] OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupNoticesListRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 891 of file GroupsModule.cs.

GroupProfileData OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupProfileRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 776 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupRoleChanges ( IClientAPI  remoteClient,
UUID  groupID,
UUID  roleID,
UUID  memberID,
uint  changes 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 969 of file GroupsModule.cs.

List<GroupRolesData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupRoleDataRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 751 of file GroupsModule.cs.

List<GroupRoleMembersData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupRoleMembersRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 760 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupRoleUpdate ( IClientAPI  remoteClient,
UUID  groupID,
UUID  roleID,
string  name,
string  description,
string  title,
ulong  powers,
byte  updateType 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 931 of file GroupsModule.cs.

List<GroupTitlesData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupTitlesRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Get the Role Titles for an Agent, for a specific group

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 708 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.GroupTitleUpdate ( IClientAPI  remoteClient,
UUID  groupID,
UUID  titleRoleID 
)
inline

Change the current Active Group Role for Agent

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 918 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 93 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.InviteGroup ( IClientAPI  remoteClient,
UUID  agentID,
UUID  groupID,
UUID  invitedAgentID,
UUID  roleID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1217 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.InviteGroupRequest ( IClientAPI  remoteClient,
UUID  groupID,
UUID  invitedAgentID,
UUID  roleID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1212 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.JoinGroupRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1072 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.LeaveGroupRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1084 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.NotifyChange ( UUID  groupID)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1493 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 250 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 160 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.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 215 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.SendAgentGroupDataUpdate ( IClientAPI  remoteClient)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1354 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.SetGroupAcceptNotices ( IClientAPI  remoteClient,
UUID  groupID,
bool  acceptNotices,
bool  listInProfile 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 837 of file GroupsModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.UpdateGroupInfo ( IClientAPI  remoteClient,
UUID  groupID,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish 
)
inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 829 of file GroupsModule.cs.

Property Documentation

string OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.Name
get

Definition at line 242 of file GroupsModule.cs.

Type OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.ReplaceableInterface
get

Definition at line 237 of file GroupsModule.cs.

Event Documentation

NewGroupNotice OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule.OnNewGroupNotice

Definition at line 682 of file GroupsModule.cs.

The documentation for this class was generated from the following file:
Generated on Wed Apr 6 2016 04:35:13 for OpenSim by   doxygen 1.8.6