IGroupsModule.cs 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System.Collections.Generic;
  28. using OpenMetaverse;
  29. using OpenSim.Framework;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public delegate void NewGroupNotice(UUID groupID, UUID noticeID);
  33. public interface IGroupsModule
  34. {
  35. event NewGroupNotice OnNewGroupNotice;
  36. /// <summary>
  37. /// Create a group
  38. /// </summary>
  39. /// <param name="remoteClient"></param>
  40. /// <param name="name"></param>
  41. /// <param name="charter"></param>
  42. /// <param name="showInList"></param>
  43. /// <param name="insigniaID"></param>
  44. /// <param name="membershipFee"></param>
  45. /// <param name="openEnrollment"></param>
  46. /// <param name="allowPublish"></param>
  47. /// <param name="maturePublish"></param>
  48. /// <returns>The UUID of the created group</returns>
  49. UUID CreateGroup(
  50. IClientAPI remoteClient, string name, string charter, bool showInList, UUID insigniaID, int membershipFee,
  51. bool openEnrollment, bool allowPublish, bool maturePublish);
  52. /// <summary>
  53. /// Get a group
  54. /// </summary>
  55. /// <param name="name">Name of the group</param>
  56. /// <returns>The group's data. Null if there is no such group.</returns>
  57. GroupRecord GetGroupRecord(string name);
  58. /// <summary>
  59. /// Get a group
  60. /// </summary>
  61. /// <param name="GroupID">ID of the group</param>
  62. /// <returns>The group's data. Null if there is no such group.</returns>
  63. GroupRecord GetGroupRecord(UUID GroupID);
  64. void ActivateGroup(IClientAPI remoteClient, UUID groupID);
  65. List<GroupTitlesData> GroupTitlesRequest(IClientAPI remoteClient, UUID groupID);
  66. List<GroupMembersData> GroupMembersRequest(IClientAPI remoteClient, UUID groupID);
  67. List<GroupRolesData> GroupRoleDataRequest(IClientAPI remoteClient, UUID groupID);
  68. List<GroupRoleMembersData> GroupRoleMembersRequest(IClientAPI remoteClient, UUID groupID);
  69. GroupProfileData GroupProfileRequest(IClientAPI remoteClient, UUID groupID);
  70. GroupMembershipData[] GetMembershipData(UUID UserID);
  71. GroupMembershipData GetMembershipData(UUID GroupID, UUID UserID);
  72. GroupMembershipData GetActiveMembershipData(UUID UserID);
  73. void UpdateGroupInfo(IClientAPI remoteClient, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish);
  74. void SetGroupAcceptNotices(IClientAPI remoteClient, UUID groupID, bool acceptNotices, bool listInProfile);
  75. void GroupTitleUpdate(IClientAPI remoteClient, UUID GroupID, UUID TitleRoleID);
  76. GroupNoticeData[] GroupNoticesListRequest(IClientAPI remoteClient, UUID GroupID);
  77. string GetGroupTitle(UUID avatarID);
  78. void GroupRoleUpdate(IClientAPI remoteClient, UUID GroupID, UUID RoleID, string name, string description, string title, ulong powers, byte updateType);
  79. void GroupRoleChanges(IClientAPI remoteClient, UUID GroupID, UUID RoleID, UUID MemberID, uint changes);
  80. void GroupNoticeRequest(IClientAPI remoteClient, UUID groupNoticeID);
  81. GridInstantMessage CreateGroupNoticeIM(UUID agentID, UUID groupNoticeID, byte dialog);
  82. void SendAgentGroupDataUpdate(IClientAPI remoteClient);
  83. void JoinGroupRequest(IClientAPI remoteClient, UUID GroupID);
  84. void LeaveGroupRequest(IClientAPI remoteClient, UUID GroupID);
  85. void EjectGroupMemberRequest(IClientAPI remoteClient, UUID GroupID, UUID EjecteeID);
  86. void EjectGroupMember(IClientAPI remoteClient, UUID agentID, UUID GroupID, UUID EjecteeID);
  87. void InviteGroupRequest(IClientAPI remoteClient, UUID GroupID, UUID InviteeID, UUID RoleID);
  88. void InviteGroup(IClientAPI remoteClient, UUID agentID, UUID GroupID, UUID InviteeID, UUID RoleID);
  89. void NotifyChange(UUID GroupID);
  90. ulong GetFullGroupPowers(UUID agentID, UUID groupID);
  91. List<GroupRolesData> GroupRoleDataRequest(UUID agentID, UUID groupID);
  92. List<DirGroupsReplyData> FindGroups(IClientAPI remoteClient, string query);
  93. }
  94. }