1
0

IGroupsServicesConnector.cs 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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;
  28. using System.Collections.Generic;
  29. using OpenMetaverse;
  30. using OpenSim.Framework;
  31. namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
  32. {
  33. public interface IGroupsServicesConnector
  34. {
  35. UUID CreateGroup(UUID RequestingAgentID, string name, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish, UUID founderID);
  36. void UpdateGroup(UUID RequestingAgentID, UUID groupID, string charter, bool showInList, UUID insigniaID, int membershipFee, bool openEnrollment, bool allowPublish, bool maturePublish);
  37. /// <summary>
  38. /// Get the group record.
  39. /// </summary>
  40. /// <returns></returns>
  41. /// <param name='RequestingAgentID'>The UUID of the user making the request.</param>
  42. /// <param name='GroupID'>
  43. /// The ID of the record to retrieve.
  44. /// GroupName may be specified instead, in which case this parameter will be UUID.Zero
  45. /// </param>
  46. /// <param name='GroupName'>
  47. /// The name of the group to retrieve.
  48. /// GroupID may be specified instead, in which case this parmeter will be null.
  49. /// </param>
  50. GroupRecord GetGroupRecord(UUID RequestingAgentID, UUID GroupID, string GroupName);
  51. List<DirGroupsReplyData> FindGroups(UUID RequestingAgentID, string search);
  52. List<GroupMembersData> GetGroupMembers(UUID RequestingAgentID, UUID GroupID);
  53. void AddGroupRole(UUID RequestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers);
  54. void UpdateGroupRole(UUID RequestingAgentID, UUID groupID, UUID roleID, string name, string description, string title, ulong powers);
  55. void RemoveGroupRole(UUID RequestingAgentID, UUID groupID, UUID roleID);
  56. List<GroupRolesData> GetGroupRoles(UUID RequestingAgentID, UUID GroupID);
  57. List<GroupRoleMembersData> GetGroupRoleMembers(UUID RequestingAgentID, UUID GroupID);
  58. void AddAgentToGroup(UUID RequestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID);
  59. void RemoveAgentFromGroup(UUID RequestingAgentID, UUID AgentID, UUID GroupID);
  60. void AddAgentToGroupInvite(UUID RequestingAgentID, UUID inviteID, UUID groupID, UUID roleID, UUID agentID);
  61. GroupInviteInfo GetAgentToGroupInvite(UUID RequestingAgentID, UUID inviteID);
  62. void RemoveAgentToGroupInvite(UUID RequestingAgentID, UUID inviteID);
  63. void AddAgentToGroupRole(UUID RequestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID);
  64. void RemoveAgentFromGroupRole(UUID RequestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID);
  65. List<GroupRolesData> GetAgentGroupRoles(UUID RequestingAgentID, UUID AgentID, UUID GroupID);
  66. void SetAgentActiveGroup(UUID RequestingAgentID, UUID AgentID, UUID GroupID);
  67. GroupMembershipData GetAgentActiveMembership(UUID RequestingAgentID, UUID AgentID);
  68. void SetAgentActiveGroupRole(UUID RequestingAgentID, UUID AgentID, UUID GroupID, UUID RoleID);
  69. void SetAgentGroupInfo(UUID RequestingAgentID, UUID AgentID, UUID GroupID, bool AcceptNotices, bool ListInProfile);
  70. /// <summary>
  71. /// Get information about a specific group to which the user belongs.
  72. /// </summary>
  73. /// <param name="RequestingAgentID">The agent requesting the information.</param>
  74. /// <param name="AgentID">The agent requested.</param>
  75. /// <param name="GroupID">The group requested.</param>
  76. /// <returns>
  77. /// If the user is a member of the group then the data structure is returned. If not, then null is returned.
  78. /// </returns>
  79. GroupMembershipData GetAgentGroupMembership(UUID RequestingAgentID, UUID AgentID, UUID GroupID);
  80. /// <summary>
  81. /// Get information about the groups to which a user belongs.
  82. /// </summary>
  83. /// <param name="RequestingAgentID">The agent requesting the information.</param>
  84. /// <param name="AgentID">The agent requested.</param>
  85. /// <returns>
  86. /// Information about the groups to which the user belongs. If the user belongs to no groups then an empty
  87. /// list is returned.
  88. /// </returns>
  89. List<GroupMembershipData> GetAgentGroupMemberships(UUID RequestingAgentID, UUID AgentID);
  90. void AddGroupNotice(UUID RequestingAgentID, UUID groupID, UUID noticeID, string fromName, string subject, string message, byte[] binaryBucket);
  91. GroupNoticeInfo GetGroupNotice(UUID RequestingAgentID, UUID noticeID);
  92. List<GroupNoticeData> GetGroupNotices(UUID RequestingAgentID, UUID GroupID);
  93. void ResetAgentGroupChatSessions(UUID agentID);
  94. bool hasAgentBeenInvitedToGroupChatSession(UUID agentID, UUID groupID);
  95. bool hasAgentDroppedGroupChatSession(UUID agentID, UUID groupID);
  96. void AgentDroppedFromGroupChatSession(UUID agentID, UUID groupID);
  97. void AgentInvitedToGroupChatSession(UUID agentID, UUID groupID);
  98. }
  99. public class GroupInviteInfo
  100. {
  101. public UUID GroupID = UUID.Zero;
  102. public UUID RoleID = UUID.Zero;
  103. public UUID AgentID = UUID.Zero;
  104. public UUID InviteID = UUID.Zero;
  105. }
  106. }