OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Properties | List of all members
OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule Class Reference
Inheritance diagram for OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule:
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 Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void AddRegion (OpenSim.Region.Framework.Scenes.Scene scene)
 
void RemoveRegion (OpenSim.Region.Framework.Scenes.Scene scene)
 
void RegionLoaded (OpenSim.Region.Framework.Scenes.Scene scene)
 
void PostInitialise ()
 This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...
 
UUID CreateGroup (UUID requestingAgentID, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish, UUID founderID)
 Create a Group, including Everyone and Owners Role, place FounderID in both groups, select Owner as selected role, and newly created group as agent's active role. More...
 
void UpdateGroup (UUID requestingAgentID, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish)
 
void AddGroupRole (UUID requestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers)
 
void RemoveGroupRole (UUID requestingAgentID, UUID groupID, UUID roleID)
 
void UpdateGroupRole (UUID requestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers)
 
GroupRecord GetGroupRecord (UUID requestingAgentID, UUID GroupID, string GroupName)
 Get the group record. More...
 
GroupProfileData GetMemberGroupProfile (UUID requestingAgentID, UUID GroupID, UUID AgentID)
 
void SetAgentActiveGroup (UUID requestingAgentID, UUID AgentID, UUID GroupID)
 
void SetAgentActiveGroupRole (UUID requestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID)
 
void SetAgentGroupInfo (UUID requestingAgentID, UUID AgentID, UUID GroupID, bool AcceptNotices, bool ListInProfile)
 
void AddAgentToGroupInvite (UUID requestingAgentID, UUID inviteID, UUID groupID, UUID roleID, UUID agentID)
 
GroupInviteInfo GetAgentToGroupInvite (UUID requestingAgentID, UUID inviteID)
 
void RemoveAgentToGroupInvite (UUID requestingAgentID, UUID inviteID)
 
void AddAgentToGroup (UUID requestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID)
 
void RemoveAgentFromGroup (UUID requestingAgentID, UUID AgentID, UUID GroupID)
 
void AddAgentToGroupRole (UUID requestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID)
 
void RemoveAgentFromGroupRole (UUID requestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID)
 
List< DirGroupsReplyDataFindGroups (UUID requestingAgentID, string search)
 
GroupMembershipData GetAgentGroupMembership (UUID requestingAgentID, UUID AgentID, UUID GroupID)
 Get information about a specific group to which the user belongs. More...
 
GroupMembershipData GetAgentActiveMembership (UUID requestingAgentID, UUID AgentID)
 
List< GroupMembershipDataGetAgentGroupMemberships (UUID requestingAgentID, UUID AgentID)
 Get information about the groups to which a user belongs. More...
 
List< GroupRolesDataGetAgentGroupRoles (UUID requestingAgentID, UUID AgentID, UUID GroupID)
 
List< GroupRolesDataGetGroupRoles (UUID requestingAgentID, UUID GroupID)
 
List< GroupMembersDataGetGroupMembers (UUID requestingAgentID, UUID GroupID)
 
List< GroupRoleMembersDataGetGroupRoleMembers (UUID requestingAgentID, UUID GroupID)
 
List< GroupNoticeDataGetGroupNotices (UUID requestingAgentID, UUID GroupID)
 
GroupNoticeInfo GetGroupNotice (UUID requestingAgentID, UUID noticeID)
 
void AddGroupNotice (UUID requestingAgentID, UUID groupID, UUID noticeID, string fromName, string subject, string message, byte[] binaryBucket)
 
void ResetAgentGroupChatSessions (UUID agentID)
 
bool hasAgentBeenInvitedToGroupChatSession (UUID agentID, UUID groupID)
 
bool hasAgentDroppedGroupChatSession (UUID agentID, UUID groupID)
 
void AgentDroppedFromGroupChatSession (UUID agentID, UUID groupID)
 
void AgentInvitedToGroupChatSession (UUID agentID, UUID groupID)
 
- Public Member Functions inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
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 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 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...
 

Public Attributes

const GroupPowers DefaultEveryonePowers
 
const GroupPowers DefaultOwnerPowers
 

Properties

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...
 

Detailed Description

Definition at line 50 of file XmlRpcGroupsServicesConnectorModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddAgentToGroup ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID,
UUID  RoleID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddAgentToGroupInvite ( UUID  requestingAgentID,
UUID  inviteID,
UUID  groupID,
UUID  roleID,
UUID  agentID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddAgentToGroupRole ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID,
UUID  RoleID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddGroupNotice ( UUID  requestingAgentID,
UUID  groupID,
UUID  noticeID,
string  fromName,
string  subject,
string  message,
byte[]  binaryBucket 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddGroupRole ( UUID  requestingAgentID,
UUID  groupID,
UUID  roleID,
string  name,
string  description,
string  title,
ulong  powers 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AddRegion ( OpenSim.Region.Framework.Scenes.Scene  scene)
inline

Definition at line 205 of file XmlRpcGroupsServicesConnectorModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AgentDroppedFromGroupChatSession ( UUID  agentID,
UUID  groupID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.AgentInvitedToGroupChatSession ( UUID  agentID,
UUID  groupID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.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 200 of file XmlRpcGroupsServicesConnectorModule.cs.

UUID OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.CreateGroup ( UUID  requestingAgentID,
string  name,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish,
UUID  founderID 
)
inline

Create a Group, including Everyone and Owners Role, place FounderID in both groups, select Owner as selected role, and newly created group as agent's active role.

Implements OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.IGroupsServicesConnector.

Definition at line 250 of file XmlRpcGroupsServicesConnectorModule.cs.

List<DirGroupsReplyData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.FindGroups ( UUID  requestingAgentID,
string  search 
)
inline
GroupMembershipData OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetAgentActiveMembership ( UUID  requestingAgentID,
UUID  AgentID 
)
inline
GroupMembershipData OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetAgentGroupMembership ( UUID  RequestingAgentID,
UUID  AgentID,
UUID  GroupID 
)
inline

Get information about a specific group to which the user belongs.

Parameters
RequestingAgentIDThe agent requesting the information.
AgentIDThe agent requested.
GroupIDThe group requested.
Returns
If the user is a member of the group then the data structure is returned. If not, then null is returned.

Implements OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.IGroupsServicesConnector.

Definition at line 530 of file XmlRpcGroupsServicesConnectorModule.cs.

List<GroupMembershipData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetAgentGroupMemberships ( UUID  RequestingAgentID,
UUID  AgentID 
)
inline

Get information about the groups to which a user belongs.

Parameters
RequestingAgentIDThe agent requesting the information.
AgentIDThe agent requested.
Returns
Information about the groups to which the user belongs. If the user belongs to no groups then an empty list is returned.

Implements OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.IGroupsServicesConnector.

Definition at line 563 of file XmlRpcGroupsServicesConnectorModule.cs.

List<GroupRolesData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetAgentGroupRoles ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID 
)
inline
GroupInviteInfo OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetAgentToGroupInvite ( UUID  requestingAgentID,
UUID  inviteID 
)
inline
List<GroupMembersData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupMembers ( UUID  requestingAgentID,
UUID  GroupID 
)
inline
GroupNoticeInfo OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupNotice ( UUID  requestingAgentID,
UUID  noticeID 
)
inline
List<GroupNoticeData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupNotices ( UUID  requestingAgentID,
UUID  GroupID 
)
inline
GroupRecord OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupRecord ( UUID  RequestingAgentID,
UUID  GroupID,
string  GroupName 
)
inline

Get the group record.

Returns
Parameters
RequestingAgentIDThe UUID of the user making the request.
GroupIDThe ID of the record to retrieve. GroupName may be specified instead, in which case this parameter will be UUID.Zero
GroupNameThe name of the group to retrieve. GroupID may be specified instead, in which case this parmeter will be null.

Implements OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.IGroupsServicesConnector.

Definition at line 347 of file XmlRpcGroupsServicesConnectorModule.cs.

List<GroupRoleMembersData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupRoleMembers ( UUID  requestingAgentID,
UUID  GroupID 
)
inline
List<GroupRolesData> OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetGroupRoles ( UUID  requestingAgentID,
UUID  GroupID 
)
inline
GroupProfileData OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.GetMemberGroupProfile ( UUID  requestingAgentID,
UUID  GroupID,
UUID  AgentID 
)
inline

Definition at line 370 of file XmlRpcGroupsServicesConnectorModule.cs.

bool OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.hasAgentBeenInvitedToGroupChatSession ( UUID  agentID,
UUID  groupID 
)
inline
bool OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.hasAgentDroppedGroupChatSession ( UUID  agentID,
UUID  groupID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.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 147 of file XmlRpcGroupsServicesConnectorModule.cs.

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

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RegionLoaded ( OpenSim.Region.Framework.Scenes.Scene  scene)
inline

Definition at line 228 of file XmlRpcGroupsServicesConnectorModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RemoveAgentFromGroup ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RemoveAgentFromGroupRole ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID,
UUID  RoleID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RemoveAgentToGroupInvite ( UUID  requestingAgentID,
UUID  inviteID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RemoveGroupRole ( UUID  requestingAgentID,
UUID  groupID,
UUID  roleID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.RemoveRegion ( OpenSim.Region.Framework.Scenes.Scene  scene)
inline

Definition at line 220 of file XmlRpcGroupsServicesConnectorModule.cs.

void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.ResetAgentGroupChatSessions ( UUID  agentID)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.SetAgentActiveGroup ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.SetAgentActiveGroupRole ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID,
UUID  RoleID 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.SetAgentGroupInfo ( UUID  requestingAgentID,
UUID  AgentID,
UUID  GroupID,
bool  AcceptNotices,
bool  ListInProfile 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.UpdateGroup ( UUID  requestingAgentID,
UUID  groupID,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish 
)
inline
void OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.UpdateGroupRole ( UUID  requestingAgentID,
UUID  groupID,
UUID  roleID,
string  name,
string  description,
string  title,
ulong  powers 
)
inline

Member Data Documentation

const GroupPowers OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.DefaultEveryonePowers
Initial value:
= GroupPowers.AllowSetHome
| GroupPowers.Accountable
| GroupPowers.JoinChat
| GroupPowers.AllowVoiceChat
| GroupPowers.ReceiveNotices
| GroupPowers.StartProposal
| GroupPowers.VoteOnProposal

Definition at line 57 of file XmlRpcGroupsServicesConnectorModule.cs.

const GroupPowers OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.XmlRpcGroupsServicesConnectorModule.DefaultOwnerPowers

Definition at line 67 of file XmlRpcGroupsServicesConnectorModule.cs.

Property Documentation

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

Definition at line 137 of file XmlRpcGroupsServicesConnectorModule.cs.

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

Definition at line 143 of file XmlRpcGroupsServicesConnectorModule.cs.


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