Inheritance diagram for OpenSim.Groups.GroupsModule:

Collaboration diagram for OpenSim.Groups.GroupsModule:

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 46 of file GroupsModule.cs.

Member Function Documentation

void OpenSim.Groups.GroupsModule.ActivateGroup	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 575 of file GroupsModule.cs.

void OpenSim.Groups.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 98 of file GroupsModule.cs.

void OpenSim.Groups.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 206 of file GroupsModule.cs.

UUID OpenSim.Groups.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 726 of file GroupsModule.cs.

Here is the call graph for this function:

GridInstantMessage OpenSim.Groups.GroupsModule.CreateGroupNoticeIM	(	UUID	agentID,
		UUID	groupNoticeID,
		byte	dialog
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 906 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.EjectGroupMember	(	IClientAPI	remoteClient,
		UUID	agentID,
		UUID	groupID,
		UUID	ejecteeID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1004 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.EjectGroupMemberRequest	(	IClientAPI	remoteClient,
		UUID	groupID,
		UUID	ejecteeID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 999 of file GroupsModule.cs.

List<DirGroupsReplyData> OpenSim.Groups.GroupsModule.FindGroups	(	IClientAPI	remoteClient,
		string	query
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1163 of file GroupsModule.cs.

GroupRecord OpenSim.Groups.GroupsModule.GetGroupRecord ( UUID GroupID )

inline

Get a group

Parameters

GroupID ID of the group

Returns: The group's data. Null if there is no such group.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 565 of file GroupsModule.cs.

GroupRecord OpenSim.Groups.GroupsModule.GetGroupRecord ( string name )

inline

Get a group

Parameters

name	Name of the group

Returns: The group's data. Null if there is no such group.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 570 of file GroupsModule.cs.

string OpenSim.Groups.GroupsModule.GetGroupTitle ( UUID avatarID )

inline

Get the title of the agent's current role.

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 802 of file GroupsModule.cs.

GroupMembershipData [] OpenSim.Groups.GroupsModule.GetMembershipData ( UUID agentID )

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 690 of file GroupsModule.cs.

GroupMembershipData OpenSim.Groups.GroupsModule.GetMembershipData	(	UUID	groupID,
		UUID	agentID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 697 of file GroupsModule.cs.

List<GroupMembersData> OpenSim.Groups.GroupsModule.GroupMembersRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 611 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.GroupNoticeRequest	(	IClientAPI	remoteClient,
		UUID	groupNoticeID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 897 of file GroupsModule.cs.

GroupNoticeData [] OpenSim.Groups.GroupsModule.GroupNoticesListRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 782 of file GroupsModule.cs.

GroupProfileData OpenSim.Groups.GroupsModule.GroupProfileRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 655 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.GroupRoleChanges	(	IClientAPI	remoteClient,
		UUID	groupID,
		UUID	roleID,
		UUID	memberID,
		uint	changes
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 871 of file GroupsModule.cs.

List<GroupRolesData> OpenSim.Groups.GroupsModule.GroupRoleDataRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 630 of file GroupsModule.cs.

List<GroupRoleMembersData> OpenSim.Groups.GroupsModule.GroupRoleMembersRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 639 of file GroupsModule.cs.

void OpenSim.Groups.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 831 of file GroupsModule.cs.

List<GroupTitlesData> OpenSim.Groups.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 587 of file GroupsModule.cs.

void OpenSim.Groups.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 817 of file GroupsModule.cs.

void OpenSim.Groups.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

source A IConfigSource

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 66 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.InviteGroup	(	IClientAPI	remoteClient,
		UUID	agentID,
		UUID	groupID,
		UUID	invitedAgentID,
		UUID	roleID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1116 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.InviteGroupRequest	(	IClientAPI	remoteClient,
		UUID	groupID,
		UUID	invitedAgentID,
		UUID	roleID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1111 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.JoinGroupRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 962 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.LeaveGroupRequest	(	IClientAPI	remoteClient,
		UUID	groupID
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 984 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.NotifyChange ( UUID groupID )

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1361 of file GroupsModule.cs.

void OpenSim.Groups.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 224 of file GroupsModule.cs.

void OpenSim.Groups.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 133 of file GroupsModule.cs.

void OpenSim.Groups.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

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 188 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.SendAgentGroupDataUpdate ( IClientAPI remoteClient )

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 1222 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.SetGroupAcceptNotices	(	IClientAPI	remoteClient,
		UUID	groupID,
		bool	acceptNotices,
		bool	listInProfile
	)

inline

Implements OpenSim.Region.Framework.Interfaces.IGroupsModule.

Definition at line 718 of file GroupsModule.cs.

void OpenSim.Groups.GroupsModule.UpdateGroupInfo	(	IClientAPI	remoteClient,
		UUID	groupID,
		string	charter,
		bool	showInList,
		UUID	insigniaID,
		int	membershipFee,
		bool	openEnrollment,
		bool	allowPublish,
		bool	maturePublish
	)