clockwerk-opensim-stable – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 vero 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  
28 using OpenMetaverse;
29 using OpenSim.Framework;
30  
31 namespace OpenSim.Region.Framework.Interfaces
32 {
33 public interface IDialogModule
34 {
35 /// <summary>
36 /// Send a non-modal alert message to a particular user. This can
37 /// disappear from the user's view after a small interval.
38 /// </summary>
39 /// <param name="client">
40 /// IClientAPI object representing the user.
41 /// </param>
42 /// <param name="message">Message text to send to the user.</param>
43 void SendAlertToUser(IClientAPI client, string message);
44  
45 /// <summary>
46 /// Send an alert message to a particular user.
47 /// </summary>
48 /// <param name="client">
49 /// IClientAPI object representing the user.
50 /// </param>
51 /// <param name="message">Message text to send to the user.</param>
52 /// <param name="modal">Flag to control modality.</param>
53 void SendAlertToUser(IClientAPI client, string message, bool modal);
54  
55 /// <summary>
56 /// Send a non-modal alert message to a particular user.
57 /// </summary>
58 /// <param name="agentID">UUID of agent representing the user.</param>
59 /// <param name="message">Message text to send to the user.</param>
60 void SendAlertToUser(UUID agentID, string message);
61  
62 /// <summary>
63 /// Send an alert message to a particular user.
64 /// </summary>
65 /// <param name="agentID">UUID of agent representing the user.</param>
66 /// <param name="message">Message text to send to the user.</param>
67 /// <param name="modal">Flag to control modality.</param>
68 void SendAlertToUser(UUID agentID, string message, bool modal);
69  
70 /// <summary>
71 /// Send an alert message to a particular user.
72 /// </summary>
73 /// <param name="firstName">Account first name</param>
74 /// <param name="lastName">Account last name</param>
75 /// <param name="message">Message text to send to the user.</param>
76 /// <param name="modal">Flag to control modality.</param>
77 void SendAlertToUser(string firstName, string lastName,
78 string message, bool modal);
79  
80 /// <summary>
81 /// Send an alert message to all users in the scene.
82 /// </summary>
83 /// <param name="message">Message text to send to all users.</param>
84 void SendGeneralAlert(string message);
85  
86 /// <summary>
87 /// Send a dialog box to a particular user.
88 /// </summary>
89 /// <param name="avatarID">
90 /// UUID of the avatar representing the user.
91 /// </param>
92 /// <param name="objectName">
93 /// Name of the object sending the dialog.
94 /// </param>
95 /// <param name="objectID">
96 /// UUID of the object sending the dialog.
97 /// </param>
98 /// <param name="ownerID">
99 /// UUID of the user that owns the object.
100 /// </param>
101 /// <param name="message">Message text to send to the user.</param>
102 /// <param name="textureID">
103 /// Texture UUID to pass along with the dialog.
104 /// </param>
105 /// <param name="ch">
106 /// Channel on which the selected button text should be broadcast.
107 /// </param>
108 /// <param name="buttonlabels">Dialog button text.</param>
109 void SendDialogToUser(UUID avatarID, string objectName, UUID objectID,
110 UUID ownerID, string message, UUID textureID, int ch,
111 string[] buttonlabels);
112  
113 /// <summary>
114 /// Send a url to a particular user.
115 /// </summary>
116 /// <param name="avatarID">
117 /// UUID of the avatar representing the user.
118 /// </param>
119 /// <param name="objectName">
120 /// Name of the object sending the dialog.
121 /// </param>
122 /// <param name="objectID">
123 /// UUID of the object sending the dialog.
124 /// </param>
125 /// <param name="ownerID">
126 /// UUID of the user that owns the object.
127 /// </param>
128 /// <param name="groupOwned">
129 /// Flag indicating whether or not the object is group-owned.
130 /// </param>
131 /// <param name="message">Message text to send to the user.</param>
132 /// <param name="url">Url to send to the user.</param>
133 void SendUrlToUser(UUID avatarID, string objectName, UUID objectID,
134 UUID ownerID, bool groupOwned, string message, string url);
135  
136 /// <summary>
137 /// Send a notification to all users in the scene. This notification
138 /// should remain around until the user explicitly dismisses it.
139 /// </summary>
140 /// <remarks>
141 /// On the Linden Labs Second Client (as of 1.21), this is a big blue
142 /// box message on the upper right of the screen.
143 /// </remarks>
144 /// <param name="fromAvatarID">The user sending the message</param>
145 /// <param name="fromAvatarName">
146 /// The name of the user doing the sending
147 /// </param>
148 /// <param name="message">The message being sent to the user</param>
149 void SendNotificationToUsersInRegion(UUID fromAvatarID,
150 string fromAvatarName, string message);
151  
152 /// <summary>
153 /// Send a textbox entry for the client to respond to
154 /// </summary>
155 /// <param name="avatarID">
156 /// UUID of the avatar representing the user.
157 /// </param>
158 /// <param name="message">Message text to send to the user.</param>
159 /// <param name="chatChannel">
160 /// Chat channel that the user's input should be broadcast on.
161 /// </param>
162 /// <param name="name">Name of the object sending the dialog.</param>
163 /// <param name="objectid">
164 /// UUID of the object sending the dialog.
165 /// </param>
166 /// <param name="ownerid">
167 /// UUID of the user that owns the object.
168 /// </param>
169 void SendTextBoxToUser(UUID avatarid, string message, int chatChannel,
170 string name, UUID objectid, UUID ownerid);
171 }
172 }