OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Events | List of all members
OpenSim.Region.Framework.Interfaces.IGroupsModule Interface Reference
Inheritance diagram for OpenSim.Region.Framework.Interfaces.IGroupsModule:
Inheritance graph
[legend]

Public Member Functions

UUID CreateGroup (IClientAPI remoteClient, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish)
 Create a group More...
 
GroupRecord GetGroupRecord (string name)
 Get a group More...
 
GroupRecord GetGroupRecord (UUID GroupID)
 Get a group More...
 
void ActivateGroup (IClientAPI remoteClient, UUID groupID)
 
List< GroupTitlesDataGroupTitlesRequest (IClientAPI remoteClient, UUID groupID)
 
List< GroupMembersDataGroupMembersRequest (IClientAPI remoteClient, UUID groupID)
 
List< GroupRolesDataGroupRoleDataRequest (IClientAPI remoteClient, UUID groupID)
 
List< GroupRoleMembersDataGroupRoleMembersRequest (IClientAPI remoteClient, UUID groupID)
 
GroupProfileData GroupProfileRequest (IClientAPI remoteClient, UUID groupID)
 
GroupMembershipData[] GetMembershipData (UUID UserID)
 
GroupMembershipData GetMembershipData (UUID GroupID, UUID UserID)
 
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)
 
void GroupTitleUpdate (IClientAPI remoteClient, UUID GroupID, UUID TitleRoleID)
 
GroupNoticeData[] GroupNoticesListRequest (IClientAPI remoteClient, UUID GroupID)
 
string GetGroupTitle (UUID avatarID)
 
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 SendAgentGroupDataUpdate (IClientAPI remoteClient)
 
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 InviteeID, UUID RoleID)
 
void InviteGroup (IClientAPI remoteClient, UUID agentID, UUID GroupID, UUID InviteeID, UUID RoleID)
 
void NotifyChange (UUID GroupID)
 
List< DirGroupsReplyDataFindGroups (IClientAPI remoteClient, string query)
 

Events

NewGroupNotice OnNewGroupNotice
 

Detailed Description

Definition at line 36 of file IGroupsModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IGroupsModule.ActivateGroup ( IClientAPI  remoteClient,
UUID  groupID 
)
UUID OpenSim.Region.Framework.Interfaces.IGroupsModule.CreateGroup ( IClientAPI  remoteClient,
string  name,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish 
)

Create a group

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

Implemented in OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule, and OpenSim.Groups.GroupsModule.

GridInstantMessage OpenSim.Region.Framework.Interfaces.IGroupsModule.CreateGroupNoticeIM ( UUID  agentID,
UUID  groupNoticeID,
byte  dialog 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.EjectGroupMember ( IClientAPI  remoteClient,
UUID  agentID,
UUID  GroupID,
UUID  EjecteeID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.EjectGroupMemberRequest ( IClientAPI  remoteClient,
UUID  GroupID,
UUID  EjecteeID 
)
List<DirGroupsReplyData> OpenSim.Region.Framework.Interfaces.IGroupsModule.FindGroups ( IClientAPI  remoteClient,
string  query 
)
GroupRecord OpenSim.Region.Framework.Interfaces.IGroupsModule.GetGroupRecord ( string  name)

Get a group

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

Implemented in OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule, and OpenSim.Groups.GroupsModule.

GroupRecord OpenSim.Region.Framework.Interfaces.IGroupsModule.GetGroupRecord ( UUID  GroupID)

Get a group

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

Implemented in OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule, and OpenSim.Groups.GroupsModule.

string OpenSim.Region.Framework.Interfaces.IGroupsModule.GetGroupTitle ( UUID  avatarID)
GroupMembershipData [] OpenSim.Region.Framework.Interfaces.IGroupsModule.GetMembershipData ( UUID  UserID)
GroupMembershipData OpenSim.Region.Framework.Interfaces.IGroupsModule.GetMembershipData ( UUID  GroupID,
UUID  UserID 
)
List<GroupMembersData> OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupMembersRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupNoticeRequest ( IClientAPI  remoteClient,
UUID  groupNoticeID 
)
GroupNoticeData [] OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupNoticesListRequest ( IClientAPI  remoteClient,
UUID  GroupID 
)
GroupProfileData OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupProfileRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupRoleChanges ( IClientAPI  remoteClient,
UUID  GroupID,
UUID  RoleID,
UUID  MemberID,
uint  changes 
)
List<GroupRolesData> OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupRoleDataRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
List<GroupRoleMembersData> OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupRoleMembersRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupRoleUpdate ( IClientAPI  remoteClient,
UUID  GroupID,
UUID  RoleID,
string  name,
string  description,
string  title,
ulong  powers,
byte  updateType 
)
List<GroupTitlesData> OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupTitlesRequest ( IClientAPI  remoteClient,
UUID  groupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.GroupTitleUpdate ( IClientAPI  remoteClient,
UUID  GroupID,
UUID  TitleRoleID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.InviteGroup ( IClientAPI  remoteClient,
UUID  agentID,
UUID  GroupID,
UUID  InviteeID,
UUID  RoleID 
)

Implemented in OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups.GroupsModule, and OpenSim.Groups.GroupsModule.

Here is the caller graph for this function:

void OpenSim.Region.Framework.Interfaces.IGroupsModule.InviteGroupRequest ( IClientAPI  remoteClient,
UUID  GroupID,
UUID  InviteeID,
UUID  RoleID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.JoinGroupRequest ( IClientAPI  remoteClient,
UUID  GroupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.LeaveGroupRequest ( IClientAPI  remoteClient,
UUID  GroupID 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.NotifyChange ( UUID  GroupID)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.SendAgentGroupDataUpdate ( IClientAPI  remoteClient)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.SetGroupAcceptNotices ( IClientAPI  remoteClient,
UUID  groupID,
bool  acceptNotices,
bool  listInProfile 
)
void OpenSim.Region.Framework.Interfaces.IGroupsModule.UpdateGroupInfo ( IClientAPI  remoteClient,
UUID  groupID,
string  charter,
bool  showInList,
UUID  insigniaID,
int  membershipFee,
bool  openEnrollment,
bool  allowPublish,
bool  maturePublish 
)

Event Documentation

NewGroupNotice OpenSim.Region.Framework.Interfaces.IGroupsModule.OnNewGroupNotice

Definition at line 38 of file IGroupsModule.cs.


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