aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
diff options
context:
space:
mode:
authorDr Scofield2009-02-06 16:55:34 +0000
committerDr Scofield2009-02-06 16:55:34 +0000
commit9b66108081a8c8cf79faaa6c541554091c40850e (patch)
tree095a232ae5a9de3a9244bcd34da08294f61eeea5 /OpenSim/Region/Framework/Interfaces/IDialogModule.cs
parent* removed superfluous constants class (diff)
downloadopensim-SC-9b66108081a8c8cf79faaa6c541554091c40850e.zip
opensim-SC-9b66108081a8c8cf79faaa6c541554091c40850e.tar.gz
opensim-SC-9b66108081a8c8cf79faaa6c541554091c40850e.tar.bz2
opensim-SC-9b66108081a8c8cf79faaa6c541554091c40850e.tar.xz
This changeset is the step 1 of 2 in refactoring
OpenSim.Region.Environment into a "framework" part and a modules only part. This first changeset refactors OpenSim.Region.Environment.Scenes, OpenSim.Region.Environment.Interfaces, and OpenSim.Region.Interfaces into OpenSim.Region.Framework.{Interfaces,Scenes} leaving only region modules in OpenSim.Region.Environment. The next step will be to move region modules up from OpenSim.Region.Environment.Modules to OpenSim.Region.CoreModules and then sort out which modules are really core modules and which should move out to forge. I've been very careful to NOT BREAK anything. i hope i've succeeded. as this is the work of a whole week i hope i managed to keep track with the applied patches of the last week --- could any of you that did check in stuff have a look at whether it survived? thx!
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IDialogModule.cs')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IDialogModule.cs136
1 files changed, 136 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IDialogModule.cs b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
new file mode 100644
index 0000000..7247d52
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs
@@ -0,0 +1,136 @@
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 OpenSim 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
28using System;
29using OpenMetaverse;
30using OpenSim.Framework;
31
32namespace OpenSim.Region.Framework.Interfaces
33{
34 public interface IDialogModule
35 {
36 /// <summary>
37 /// Send a non-modal alert message to a particular user. This can disappear from the user's view after a
38 /// small interval.
39 /// </summary>
40 /// <param name="client"></param>
41 /// <param name="message"></param>
42 void SendAlertToUser(IClientAPI client, string message);
43
44 /// <summary>
45 /// Send an alert message to a particular user.
46 /// </summary>
47 /// <param name="client"></param>
48 /// <param name="message"></param>
49 /// <param name="modal"></param>
50 void SendAlertToUser(IClientAPI client, string message, bool modal);
51
52 /// <summary>
53 /// Send a non-modal alert message to a particular user.
54 /// </summary>
55 /// <param name="agentID"></param>
56 /// <param name="message"></param>
57 void SendAlertToUser(UUID agentID, string message);
58
59 /// <summary>
60 /// Send an alert message to a particular user.
61 /// </summary>
62 /// <param name="agentID"></param>
63 /// <param name="message"></param>
64 /// <param name="modal"></param>
65 void SendAlertToUser(UUID agentID, string message, bool modal);
66
67 /// <summary>
68 /// Send an alert message to a particular user.
69 /// </summary>
70 /// <param name="firstName"></param>
71 /// <param name="lastName"></param>
72 /// <param name="message"></param>
73 /// <param name="modal"></param>
74 void SendAlertToUser(string firstName, string lastName, string message, bool modal);
75
76 /// <summary>
77 /// Send an alert message to all users in the scene.
78 /// </summary>
79 /// <param name="message"></param>
80 void SendGeneralAlert(string message);
81
82 /// <summary>
83 /// Send a dialog box to a particular user.
84 /// </summary>
85 /// <param name="avatarID"></param>
86 /// <param name="objectName"></param>
87 /// <param name="objectID"></param>
88 /// <param name="ownerID"></param>
89 /// <param name="message"></param>
90 /// <param name="textureID"></param>
91 /// <param name="ch"></param>
92 /// <param name="buttonlabels"></param>
93 void SendDialogToUser(
94 UUID avatarID, string objectName, UUID objectID, UUID ownerID,
95 string message, UUID textureID, int ch, string[] buttonlabels);
96
97 /// <summary>
98 /// Send a url to a particular user.
99 /// </summary>
100 /// <param name="avatarID"></param>
101 /// <param name="objectName"></param>
102 /// <param name="objectID"></param>
103 /// <param name="ownerID"></param>
104 /// <param name="groupOwned"></param>
105 /// <param name="message"></param>
106 /// <param name="url"></param>
107 void SendUrlToUser(
108 UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url);
109
110 /// <summary>
111 /// Send a notification to all users in the scene. This notification should remain around until the
112 /// user explicitly dismisses it.
113 /// </summary>
114 ///
115 /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the
116 /// screen.
117 ///
118 /// <param name="fromAvatarID">The user sending the message</param>
119 /// <param name="fromAvatarName">The name of the user doing the sending</param>
120 /// <param name="message">The message being sent to the user</param>
121 void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message);
122
123 /// <summary>
124 /// Send a notification to all users in the estate. This notification should remain around until the
125 /// user explicitly dismisses it.
126 /// </summary>
127 ///
128 /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the
129 /// screen.
130 ///
131 /// <param name="fromAvatarID">The user sending the message</param>
132 /// <param name="fromAvatarName">The name of the user doing the sending</param>
133 /// <param name="message">The message being sent to the user</param>
134 void SendNotificationToUsersInEstate(UUID fromAvatarID, string fromAvatarName, string message);
135 }
136}