1
0

IDialogModule.cs 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  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. public interface IDialogModule
  32. {
  33. /// <summary>
  34. /// Send a non-modal alert message to a particular user. This can disappear from the user's view after a
  35. /// small interval.
  36. /// </summary>
  37. /// <param name="client"></param>
  38. /// <param name="message"></param>
  39. void SendAlertToUser(IClientAPI client, string message);
  40. /// <summary>
  41. /// Send an alert message to a particular user.
  42. /// </summary>
  43. /// <param name="client"></param>
  44. /// <param name="message"></param>
  45. /// <param name="modal"></param>
  46. void SendAlertToUser(IClientAPI client, string message, bool modal);
  47. /// <summary>
  48. /// Send a non-modal alert message to a particular user.
  49. /// </summary>
  50. /// <param name="agentID"></param>
  51. /// <param name="message"></param>
  52. void SendAlertToUser(UUID agentID, string message);
  53. /// <summary>
  54. /// Send an alert message to a particular user.
  55. /// </summary>
  56. /// <param name="agentID"></param>
  57. /// <param name="message"></param>
  58. /// <param name="modal"></param>
  59. void SendAlertToUser(UUID agentID, string message, bool modal);
  60. /// <summary>
  61. /// Send an alert message to a particular user.
  62. /// </summary>
  63. /// <param name="firstName"></param>
  64. /// <param name="lastName"></param>
  65. /// <param name="message"></param>
  66. /// <param name="modal"></param>
  67. void SendAlertToUser(string firstName, string lastName, string message, bool modal);
  68. /// <summary>
  69. /// Send an alert message to all users in the scene.
  70. /// </summary>
  71. /// <param name="message"></param>
  72. void SendGeneralAlert(string message);
  73. /// <summary>
  74. /// Send a dialog box to a particular user.
  75. /// </summary>
  76. /// <param name="avatarID"></param>
  77. /// <param name="objectName"></param>
  78. /// <param name="objectID"></param>
  79. /// <param name="ownerID"></param>
  80. /// <param name="message"></param>
  81. /// <param name="textureID"></param>
  82. /// <param name="ch"></param>
  83. /// <param name="buttonlabels"></param>
  84. void SendDialogToUser(
  85. UUID avatarID, string objectName, UUID objectID, UUID ownerID,
  86. string message, UUID textureID, int ch, string[] buttonlabels);
  87. /// <summary>
  88. /// Send a url to a particular user.
  89. /// </summary>
  90. /// <param name="avatarID"></param>
  91. /// <param name="objectName"></param>
  92. /// <param name="objectID"></param>
  93. /// <param name="ownerID"></param>
  94. /// <param name="groupOwned"></param>
  95. /// <param name="message"></param>
  96. /// <param name="url"></param>
  97. void SendUrlToUser(
  98. UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url);
  99. /// <summary>
  100. /// Send a notification to all users in the scene. This notification should remain around until the
  101. /// user explicitly dismisses it.
  102. /// </summary>
  103. ///
  104. /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the
  105. /// screen.
  106. ///
  107. /// <param name="fromAvatarID">The user sending the message</param>
  108. /// <param name="fromAvatarName">The name of the user doing the sending</param>
  109. /// <param name="message">The message being sent to the user</param>
  110. void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message);
  111. /// <summary>
  112. /// Send a textbox entry for the client to respond to
  113. /// </summary>
  114. void SendTextBoxToUser(UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid);
  115. }
  116. }