diff options
author | SignpostMarv | 2012-11-04 10:57:15 +0000 |
---|---|---|
committer | Diva Canto | 2012-11-10 08:12:30 -0800 |
commit | ee3d06220ef8ddbbc8af24981e147494110ed5c1 (patch) | |
tree | 24a4c65128e7104f963459d38e5a91642e85205d /OpenSim/Region/Framework/Interfaces/IDialogModule.cs | |
parent | One more module converted: J2KDecoderModule. (diff) | |
download | opensim-SC_OLD-ee3d06220ef8ddbbc8af24981e147494110ed5c1.zip opensim-SC_OLD-ee3d06220ef8ddbbc8af24981e147494110ed5c1.tar.gz opensim-SC_OLD-ee3d06220ef8ddbbc8af24981e147494110ed5c1.tar.bz2 opensim-SC_OLD-ee3d06220ef8ddbbc8af24981e147494110ed5c1.tar.xz |
Documenting parameters of methods on the IDialogModule interface
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces/IDialogModule.cs')
-rw-r--r-- | OpenSim/Region/Framework/Interfaces/IDialogModule.cs | 106 |
1 files changed, 73 insertions, 33 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IDialogModule.cs b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs index be9764a..d1e9df0 100644 --- a/OpenSim/Region/Framework/Interfaces/IDialogModule.cs +++ b/OpenSim/Region/Framework/Interfaces/IDialogModule.cs | |||
@@ -36,59 +36,75 @@ namespace OpenSim.Region.Framework.Interfaces | |||
36 | /// Send a non-modal alert message to a particular user. This can disappear from the user's view after a | 36 | /// Send a non-modal alert message to a particular user. This can disappear from the user's view after a |
37 | /// small interval. | 37 | /// small interval. |
38 | /// </summary> | 38 | /// </summary> |
39 | /// <param name="client"></param> | 39 | /// <param name="client"> |
40 | /// <param name="message"></param> | 40 | /// IClientAPI object representing the user. |
41 | /// </param> | ||
42 | /// <param name="message">Message text to send to the user.</param> | ||
41 | void SendAlertToUser(IClientAPI client, string message); | 43 | void SendAlertToUser(IClientAPI client, string message); |
42 | 44 | ||
43 | /// <summary> | 45 | /// <summary> |
44 | /// Send an alert message to a particular user. | 46 | /// Send an alert message to a particular user. |
45 | /// </summary> | 47 | /// </summary> |
46 | /// <param name="client"></param> | 48 | /// <param name="client"> |
47 | /// <param name="message"></param> | 49 | /// IClientAPI object representing the user. |
48 | /// <param name="modal"></param> | 50 | /// </param> |
51 | /// <param name="message">Message text to send to the user.</param> | ||
52 | /// <param name="modal">Flag to control modality.</param> | ||
49 | void SendAlertToUser(IClientAPI client, string message, bool modal); | 53 | void SendAlertToUser(IClientAPI client, string message, bool modal); |
50 | 54 | ||
51 | /// <summary> | 55 | /// <summary> |
52 | /// Send a non-modal alert message to a particular user. | 56 | /// Send a non-modal alert message to a particular user. |
53 | /// </summary> | 57 | /// </summary> |
54 | /// <param name="agentID"></param> | 58 | /// <param name="agentID">UUID of agent representing the user.</param> |
55 | /// <param name="message"></param> | 59 | /// <param name="message">Message text to send to the user.</param> |
56 | void SendAlertToUser(UUID agentID, string message); | 60 | void SendAlertToUser(UUID agentID, string message); |
57 | 61 | ||
58 | /// <summary> | 62 | /// <summary> |
59 | /// Send an alert message to a particular user. | 63 | /// Send an alert message to a particular user. |
60 | /// </summary> | 64 | /// </summary> |
61 | /// <param name="agentID"></param> | 65 | /// <param name="agentID">UUID of agent representing the user.</param> |
62 | /// <param name="message"></param> | 66 | /// <param name="message">Message text to send to the user.</param> |
63 | /// <param name="modal"></param> | 67 | /// <param name="modal">Flag to control modality.</param> |
64 | void SendAlertToUser(UUID agentID, string message, bool modal); | 68 | void SendAlertToUser(UUID agentID, string message, bool modal); |
65 | 69 | ||
66 | /// <summary> | 70 | /// <summary> |
67 | /// Send an alert message to a particular user. | 71 | /// Send an alert message to a particular user. |
68 | /// </summary> | 72 | /// </summary> |
69 | /// <param name="firstName"></param> | 73 | /// <param name="firstName">Account first name</param> |
70 | /// <param name="lastName"></param> | 74 | /// <param name="lastName">Account last name</param> |
71 | /// <param name="message"></param> | 75 | /// <param name="message">Message text to send to the user.</param> |
72 | /// <param name="modal"></param> | 76 | /// <param name="modal">Flag to control modality.</param> |
73 | void SendAlertToUser(string firstName, string lastName, string message, bool modal); | 77 | void SendAlertToUser(string firstName, string lastName, string message, bool modal); |
74 | 78 | ||
75 | /// <summary> | 79 | /// <summary> |
76 | /// Send an alert message to all users in the scene. | 80 | /// Send an alert message to all users in the scene. |
77 | /// </summary> | 81 | /// </summary> |
78 | /// <param name="message"></param> | 82 | /// <param name="message">Message text to send to all users.</param> |
79 | void SendGeneralAlert(string message); | 83 | void SendGeneralAlert(string message); |
80 | 84 | ||
81 | /// <summary> | 85 | /// <summary> |
82 | /// Send a dialog box to a particular user. | 86 | /// Send a dialog box to a particular user. |
83 | /// </summary> | 87 | /// </summary> |
84 | /// <param name="avatarID"></param> | 88 | /// <param name="avatarID"> |
85 | /// <param name="objectName"></param> | 89 | /// UUID of the avatar representing the user. |
86 | /// <param name="objectID"></param> | 90 | /// </param> |
87 | /// <param name="ownerID"></param> | 91 | /// <param name="objectName"> |
88 | /// <param name="message"></param> | 92 | /// Name of the object sending the dialog. |
89 | /// <param name="textureID"></param> | 93 | /// </param> |
90 | /// <param name="ch"></param> | 94 | /// <param name="objectID"> |
91 | /// <param name="buttonlabels"></param> | 95 | /// UUID of the object sending the dialog. |
96 | /// </param> | ||
97 | /// <param name="ownerID"> | ||
98 | /// UUID of the user that owns the object. | ||
99 | /// </param> | ||
100 | /// <param name="message">Message text to send to the user.</param> | ||
101 | /// <param name="textureID"> | ||
102 | /// Texture UUID to pass along with the dialog. | ||
103 | /// </param> | ||
104 | /// <param name="ch"> | ||
105 | /// Channel on which the selected button text should be broadcast. | ||
106 | /// </param> | ||
107 | /// <param name="buttonlabels">Dialog button text.</param> | ||
92 | void SendDialogToUser( | 108 | void SendDialogToUser( |
93 | UUID avatarID, string objectName, UUID objectID, UUID ownerID, | 109 | UUID avatarID, string objectName, UUID objectID, UUID ownerID, |
94 | string message, UUID textureID, int ch, string[] buttonlabels); | 110 | string message, UUID textureID, int ch, string[] buttonlabels); |
@@ -96,13 +112,23 @@ namespace OpenSim.Region.Framework.Interfaces | |||
96 | /// <summary> | 112 | /// <summary> |
97 | /// Send a url to a particular user. | 113 | /// Send a url to a particular user. |
98 | /// </summary> | 114 | /// </summary> |
99 | /// <param name="avatarID"></param> | 115 | /// <param name="avatarID"> |
100 | /// <param name="objectName"></param> | 116 | /// UUID of the avatar representing the user. |
101 | /// <param name="objectID"></param> | 117 | /// </param> |
102 | /// <param name="ownerID"></param> | 118 | /// <param name="objectName"> |
103 | /// <param name="groupOwned"></param> | 119 | /// Name of the object sending the dialog. |
104 | /// <param name="message"></param> | 120 | /// </param> |
105 | /// <param name="url"></param> | 121 | /// <param name="objectID"> |
122 | /// UUID of the object sending the dialog. | ||
123 | /// </param> | ||
124 | /// <param name="ownerID"> | ||
125 | /// UUID of the user that owns the object. | ||
126 | /// </param> | ||
127 | /// <param name="groupOwned"> | ||
128 | /// Flag indicating whether or not the object is group-owned. | ||
129 | /// </param> | ||
130 | /// <param name="message">Message text to send to the user.</param> | ||
131 | /// <param name="url">Url to send to the user.</param> | ||
106 | void SendUrlToUser( | 132 | void SendUrlToUser( |
107 | UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url); | 133 | UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url); |
108 | 134 | ||
@@ -110,18 +136,32 @@ namespace OpenSim.Region.Framework.Interfaces | |||
110 | /// Send a notification to all users in the scene. This notification should remain around until the | 136 | /// Send a notification to all users in the scene. This notification should remain around until the |
111 | /// user explicitly dismisses it. | 137 | /// user explicitly dismisses it. |
112 | /// </summary> | 138 | /// </summary> |
113 | /// | 139 | /// <remarks> |
114 | /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the | 140 | /// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the |
115 | /// screen. | 141 | /// screen. |
116 | /// | 142 | /// </remarks> |
117 | /// <param name="fromAvatarID">The user sending the message</param> | 143 | /// <param name="fromAvatarID">The user sending the message</param> |
118 | /// <param name="fromAvatarName">The name of the user doing the sending</param> | 144 | /// <param name="fromAvatarName">The name of the user doing the sending</param> |
119 | /// <param name="message">The message being sent to the user</param> | 145 | /// <param name="message">The message being sent to the user</param> |
120 | void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message); | 146 | void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message); |
121 | 147 | ||
122 | /// <summary> | 148 | /// <summary> |
123 | /// Send a textbox entry for the client to respond to | 149 | /// Send a textbox entry for the client to respond to |
124 | /// </summary> | 150 | /// </summary> |
151 | /// <param name="avatarID"> | ||
152 | /// UUID of the avatar representing the user. | ||
153 | /// </param> | ||
154 | /// <param name="message">Message text to send to the user.</param> | ||
155 | /// <param name="chatChannel"> | ||
156 | /// Chat channel that the user's input should be broadcast on. | ||
157 | /// </param> | ||
158 | /// <param name="name">Name of the object sending the dialog.</param> | ||
159 | /// <param name="objectid"> | ||
160 | /// UUID of the object sending the dialog. | ||
161 | /// </param> | ||
162 | /// <param name="ownerid"> | ||
163 | /// UUID of the user that owns the object. | ||
164 | /// </param> | ||
125 | void SendTextBoxToUser(UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid); | 165 | void SendTextBoxToUser(UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid); |
126 | } | 166 | } |
127 | } | 167 | } |