OpenSim
/
OpenSimMirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documenting parameters of methods on the IDialogModule interface

integration
SignpostMarv 2012-11-04 10:57:15 +00:00 committed by Diva Canto
parent 791c4d5b9f
commit ee3d06220e
1 changed files with 73 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
OpenSim/Region/Framework/Interfaces/IDialogModule.cs
View File

@ -36,59 +36,75 @@ namespace OpenSim.Region.Framework.Interfaces
/// Send a non-modal alert message to a particular user. This can disappear from the user's view after a
/// small interval.
/// </summary>
/// <param name="client"></param>
/// <param name="message"></param>
/// <param name="client">
/// IClientAPI object representing the user.
/// </param>
/// <param name="message">Message text to send to the user.</param>
void SendAlertToUser(IClientAPI client, string message);
/// <summary>
/// Send an alert message to a particular user.
/// </summary>
/// <param name="client"></param>
/// <param name="message"></param>
/// <param name="modal"></param>
/// <param name="client">
/// IClientAPI object representing the user.
/// </param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="modal">Flag to control modality.</param>
void SendAlertToUser(IClientAPI client, string message, bool modal);
/// <summary>
/// Send a non-modal alert message to a particular user.
/// </summary>
/// <param name="agentID"></param>
/// <param name="message"></param>
/// <param name="agentID">UUID of agent representing the user.</param>
/// <param name="message">Message text to send to the user.</param>
void SendAlertToUser(UUID agentID, string message);
/// <summary>
/// Send an alert message to a particular user.
/// </summary>
/// <param name="agentID"></param>
/// <param name="message"></param>
/// <param name="modal"></param>
/// <param name="agentID">UUID of agent representing the user.</param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="modal">Flag to control modality.</param>
void SendAlertToUser(UUID agentID, string message, bool modal);
/// <summary>
/// Send an alert message to a particular user.
/// </summary>
/// <param name="firstName"></param>
/// <param name="lastName"></param>
/// <param name="message"></param>
/// <param name="modal"></param>
/// <param name="firstName">Account first name</param>
/// <param name="lastName">Account last name</param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="modal">Flag to control modality.</param>
void SendAlertToUser(string firstName, string lastName, string message, bool modal);
/// <summary>
/// Send an alert message to all users in the scene.
/// </summary>
/// <param name="message"></param>
/// <param name="message">Message text to send to all users.</param>
void SendGeneralAlert(string message);
/// <summary>
/// Send a dialog box to a particular user.
/// </summary>
/// <param name="avatarID"></param>
/// <param name="objectName"></param>
/// <param name="objectID"></param>
/// <param name="ownerID"></param>
/// <param name="message"></param>
/// <param name="textureID"></param>
/// <param name="ch"></param>
/// <param name="buttonlabels"></param>
/// <param name="avatarID">
/// UUID of the avatar representing the user.
/// </param>
/// <param name="objectName">
/// Name of the object sending the dialog.
/// </param>
/// <param name="objectID">
/// UUID of the object sending the dialog.
/// </param>
/// <param name="ownerID">
/// UUID of the user that owns the object.
/// </param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="textureID">
/// Texture UUID to pass along with the dialog.
/// </param>
/// <param name="ch">
/// Channel on which the selected button text should be broadcast.
/// </param>
/// <param name="buttonlabels">Dialog button text.</param>
void SendDialogToUser(
UUID avatarID, string objectName, UUID objectID, UUID ownerID,
string message, UUID textureID, int ch, string[] buttonlabels);
@ -96,13 +112,23 @@ namespace OpenSim.Region.Framework.Interfaces
/// <summary>
/// Send a url to a particular user.
/// </summary>
/// <param name="avatarID"></param>
/// <param name="objectName"></param>
/// <param name="objectID"></param>
/// <param name="ownerID"></param>
/// <param name="groupOwned"></param>
/// <param name="message"></param>
/// <param name="url"></param>
/// <param name="avatarID">
/// UUID of the avatar representing the user.
/// </param>
/// <param name="objectName">
/// Name of the object sending the dialog.
/// </param>
/// <param name="objectID">
/// UUID of the object sending the dialog.
/// </param>
/// <param name="ownerID">
/// UUID of the user that owns the object.
/// </param>
/// <param name="groupOwned">
/// Flag indicating whether or not the object is group-owned.
/// </param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="url">Url to send to the user.</param>
void SendUrlToUser(
UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url);
@ -110,18 +136,32 @@ namespace OpenSim.Region.Framework.Interfaces
/// Send a notification to all users in the scene. This notification should remain around until the
/// user explicitly dismisses it.
/// </summary>
///
/// <remarks>
/// On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the
/// screen.
///
/// </remarks>
/// <param name="fromAvatarID">The user sending the message</param>
/// <param name="fromAvatarName">The name of the user doing the sending</param>
/// <param name="message">The message being sent to the user</param>
void SendNotificationToUsersInRegion(UUID fromAvatarID, string fromAvatarName, string message);
/// <summary>
/// Send a textbox entry for the client to respond to
/// </summary>
/// <param name="avatarID">
/// UUID of the avatar representing the user.
/// </param>
/// <param name="message">Message text to send to the user.</param>
/// <param name="chatChannel">
/// Chat channel that the user's input should be broadcast on.
/// </param>
/// <param name="name">Name of the object sending the dialog.</param>
/// <param name="objectid">
/// UUID of the object sending the dialog.
/// </param>
/// <param name="ownerid">
/// UUID of the user that owns the object.
/// </param>
void SendTextBoxToUser(UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid);
}
}