Inheritance diagram for OpenSim.Groups.GroupsServiceRemoteConnectorModule:

Collaboration diagram for OpenSim.Groups.GroupsServiceRemoteConnectorModule:

Public Member Functions
	GroupsServiceRemoteConnectorModule ()

	GroupsServiceRemoteConnectorModule (IConfigSource config, IUserManagement uman)

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

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

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

UUID	CreateGroup (UUID RequestingAgentID, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish, UUID founderID, out string reason)

bool	UpdateGroup (string RequestingAgentID, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish, out string reason)

ExtendedGroupRecord	GetGroupRecord (string RequestingAgentID, UUID GroupID, string GroupName)

List< DirGroupsReplyData >	FindGroups (string RequestingAgentID, string search)

bool	AddAgentToGroup (string RequestingAgentID, string AgentID, UUID GroupID, UUID RoleID, string token, out string reason)

void	RemoveAgentFromGroup (string RequestingAgentID, string AgentID, UUID GroupID)

void	SetAgentActiveGroup (string RequestingAgentID, string AgentID, UUID GroupID)

ExtendedGroupMembershipData	GetAgentActiveMembership (string RequestingAgentID, string AgentID)

ExtendedGroupMembershipData	GetAgentGroupMembership (string RequestingAgentID, string AgentID, UUID GroupID)
	Get information about a specific group to which the user belongs. More...

List< GroupMembershipData >	GetAgentGroupMemberships (string RequestingAgentID, string AgentID)
	Get information about the groups to which a user belongs. More...

List< GroupMembersData >	GetGroupMembers (string RequestingAgentID, UUID GroupID)

bool	AddGroupRole (string RequestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers, out string reason)

bool	UpdateGroupRole (string RequestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers)

void	RemoveGroupRole (string RequestingAgentID, UUID groupID, UUID roleID)

List< GroupRolesData >	GetGroupRoles (string RequestingAgentID, UUID GroupID)

List< GroupRoleMembersData >	GetGroupRoleMembers (string RequestingAgentID, UUID GroupID)

void	AddAgentToGroupRole (string RequestingAgentID, string AgentID, UUID GroupID, UUID RoleID)

void	RemoveAgentFromGroupRole (string RequestingAgentID, string AgentID, UUID GroupID, UUID RoleID)

List< GroupRolesData >	GetAgentGroupRoles (string RequestingAgentID, string AgentID, UUID GroupID)

void	SetAgentActiveGroupRole (string RequestingAgentID, string AgentID, UUID GroupID, UUID RoleID)

void	UpdateMembership (string RequestingAgentID, string AgentID, UUID GroupID, bool AcceptNotices, bool ListInProfile)

bool	AddAgentToGroupInvite (string RequestingAgentID, UUID inviteID, UUID groupID, UUID roleID, string agentID)

GroupInviteInfo	GetAgentToGroupInvite (string RequestingAgentID, UUID inviteID)

void	RemoveAgentToGroupInvite (string RequestingAgentID, UUID inviteID)

bool	AddGroupNotice (string RequestingAgentID, UUID groupID, UUID noticeID, string fromName, string subject, string message, bool hasAttachment, byte attType, string attName, UUID attItemID, string attOwnerID)

GroupNoticeInfo	GetGroupNotice (string RequestingAgentID, UUID noticeID)

List< ExtendedGroupNoticeData >	GetGroupNotices (string RequestingAgentID, UUID GroupID)

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 49 of file GroupsServiceRemoteConnectorModule.cs.

Constructor & Destructor Documentation

OpenSim.Groups.GroupsServiceRemoteConnectorModule.GroupsServiceRemoteConnectorModule ( )

inline

Definition at line 61 of file GroupsServiceRemoteConnectorModule.cs.

OpenSim.Groups.GroupsServiceRemoteConnectorModule.GroupsServiceRemoteConnectorModule	(	IConfigSource	config,
		IUserManagement	uman
	)

inline

Definition at line 65 of file GroupsServiceRemoteConnectorModule.cs.

Member Function Documentation

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.AddAgentToGroup	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID,
		UUID	RoleID,
		string	token,
		out string	reason
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 201 of file GroupsServiceRemoteConnectorModule.cs.

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.AddAgentToGroupInvite	(	string	RequestingAgentID,
		UUID	inviteID,
		UUID	groupID,
		UUID	roleID,
		string	agentID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 350 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.AddAgentToGroupRole	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID,
		UUID	RoleID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 310 of file GroupsServiceRemoteConnectorModule.cs.

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.AddGroupNotice	(	string	RequestingAgentID,
		UUID	groupID,
		UUID	noticeID,
		string	fromName,
		string	subject,
		string	message,
		bool	hasAttachment,
		byte	attType,
		string	attName,
		UUID	attItemID,
		string	attOwnerID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 365 of file GroupsServiceRemoteConnectorModule.cs.

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.AddGroupRole	(	string	RequestingAgentID,
		UUID	groupID,
		UUID	roleID,
		string	name,
		string	description,
		string	title,
		ulong	powers,
		out string	reason
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 266 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 111 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 146 of file GroupsServiceRemoteConnectorModule.cs.

UUID OpenSim.Groups.GroupsServiceRemoteConnectorModule.CreateGroup	(	UUID	RequestingAgentID,
		string	name,
		string	charter,
		bool	showInList,
		UUID	insigniaID,
		int	membershipFee,
		bool	openEnrollment,
		bool	allowPublish,
		bool	maturePublish,
		UUID	founderID,
		out string	reason
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 154 of file GroupsServiceRemoteConnectorModule.cs.

List<DirGroupsReplyData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.FindGroups	(	string	RequestingAgentID,
		string	search
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 195 of file GroupsServiceRemoteConnectorModule.cs.

ExtendedGroupMembershipData OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetAgentActiveMembership	(	string	RequestingAgentID,
		string	AgentID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 233 of file GroupsServiceRemoteConnectorModule.cs.

ExtendedGroupMembershipData OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetAgentGroupMembership	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID
	)

inline

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

Parameters

RequestingAgentID	The agent requesting the information.
AgentID	The agent requested.
GroupID	The 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.Groups.IGroupsServicesConnector.

Definition at line 241 of file GroupsServiceRemoteConnectorModule.cs.

List<GroupMembershipData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetAgentGroupMemberships	(	string	RequestingAgentID,
		string	AgentID
	)

inline

Get information about the groups to which a user belongs.

Parameters

RequestingAgentID	The agent requesting the information.
AgentID	The 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.Groups.IGroupsServicesConnector.

Definition at line 249 of file GroupsServiceRemoteConnectorModule.cs.

List<GroupRolesData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetAgentGroupRoles	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 326 of file GroupsServiceRemoteConnectorModule.cs.

GroupInviteInfo OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetAgentToGroupInvite	(	string	RequestingAgentID,
		UUID	inviteID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 355 of file GroupsServiceRemoteConnectorModule.cs.

List<GroupMembersData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupMembers	(	string	RequestingAgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 258 of file GroupsServiceRemoteConnectorModule.cs.

GroupNoticeInfo OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupNotice	(	string	RequestingAgentID,
		UUID	noticeID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 389 of file GroupsServiceRemoteConnectorModule.cs.

List<ExtendedGroupNoticeData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupNotices	(	string	RequestingAgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 397 of file GroupsServiceRemoteConnectorModule.cs.

ExtendedGroupRecord OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupRecord	(	string	RequestingAgentID,
		UUID	GroupID,
		string	GroupName
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 184 of file GroupsServiceRemoteConnectorModule.cs.

List<GroupRoleMembersData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupRoleMembers	(	string	RequestingAgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 302 of file GroupsServiceRemoteConnectorModule.cs.

List<GroupRolesData> OpenSim.Groups.GroupsServiceRemoteConnectorModule.GetGroupRoles	(	string	RequestingAgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 294 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 83 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 142 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 130 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.RemoveAgentFromGroup	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 216 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.RemoveAgentFromGroupRole	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID,
		UUID	RoleID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 318 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.RemoveAgentToGroupInvite	(	string	RequestingAgentID,
		UUID	inviteID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 360 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.RemoveGroupRole	(	string	RequestingAgentID,
		UUID	groupID,
		UUID	roleID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 286 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.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 121 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.SetAgentActiveGroup	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 225 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.SetAgentActiveGroupRole	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID,
		UUID	RoleID
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 334 of file GroupsServiceRemoteConnectorModule.cs.

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.UpdateGroup	(	string	RequestingAgentID,
		UUID	groupID,
		string	charter,
		bool	showInList,
		UUID	insigniaID,
		int	membershipFee,
		bool	openEnrollment,
		bool	allowPublish,
		bool	maturePublish,
		out string	reason
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 170 of file GroupsServiceRemoteConnectorModule.cs.

bool OpenSim.Groups.GroupsServiceRemoteConnectorModule.UpdateGroupRole	(	string	RequestingAgentID,
		UUID	groupID,
		UUID	roleID,
		string	name,
		string	description,
		string	title,
		ulong	powers
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 278 of file GroupsServiceRemoteConnectorModule.cs.

void OpenSim.Groups.GroupsServiceRemoteConnectorModule.UpdateMembership	(	string	RequestingAgentID,
		string	AgentID,
		UUID	GroupID,
		bool	AcceptNotices,
		bool	ListInProfile
	)

inline

Implements OpenSim.Groups.IGroupsServicesConnector.

Definition at line 342 of file GroupsServiceRemoteConnectorModule.cs.

Property Documentation

string OpenSim.Groups.GroupsServiceRemoteConnectorModule.Name

get

Definition at line 102 of file GroupsServiceRemoteConnectorModule.cs.

Type OpenSim.Groups.GroupsServiceRemoteConnectorModule.ReplaceableInterface

get

Definition at line 107 of file GroupsServiceRemoteConnectorModule.cs.

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

Addons/Groups/Remote/GroupsServiceRemoteConnectorModule.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation