1
0

IGroupsMessagingModule.cs 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 OpenMetaverse;
  28. using OpenSim.Framework;
  29. namespace OpenSim.Region.Framework.Interfaces
  30. {
  31. /// <summary>
  32. /// Provide mechanisms for messaging groups.
  33. /// </summary>
  34. ///
  35. /// TODO: Provide a mechanism for receiving group messages as well as sending them
  36. ///
  37. public interface IGroupsMessagingModule
  38. {
  39. /// <summary>
  40. /// Start a group chat session.
  41. /// </summary>
  42. /// You must call this before calling SendMessageToGroup(). If a chat session for this group is already taking
  43. /// place then the agent will added to that session.
  44. /// <param name="agentID">
  45. /// A UUID that represents the agent being added. If you are agentless (e.g. you are
  46. /// a region module), then you can use any random ID.
  47. /// </param>
  48. /// <param name="groupID">
  49. /// The ID for the group to join. Currently, the session ID used is identical to the
  50. /// group ID.
  51. /// </param>
  52. /// <returns>
  53. /// True if the chat session was started successfully, false otherwise.
  54. /// </returns>
  55. bool StartGroupChatSession(UUID agentID, UUID groupID);
  56. /// <summary>
  57. /// Send a message to an entire group.
  58. /// </summary>
  59. /// <param name="im">
  60. /// The message itself. The fields that must be populated are
  61. ///
  62. /// imSessionID - Populate this with the group ID (session ID and group ID are currently identical)
  63. /// fromAgentName - Populate this with whatever arbitrary name you want to show up in the chat dialog
  64. /// message - The message itself
  65. /// dialog - This must be (byte)InstantMessageDialog.SessionSend
  66. /// </param>
  67. /// <param name="groupID"></param>
  68. void SendMessageToGroup(GridInstantMessage im, UUID groupID);
  69. }
  70. }