OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | List of all members
OpenSim.Region.Framework.Interfaces.IDialogModule Interface Reference
Inheritance diagram for OpenSim.Region.Framework.Interfaces.IDialogModule:
Inheritance graph
[legend]

Public Member Functions

void SendAlertToUser (IClientAPI client, string message)
 Send a non-modal alert message to a particular user. This can disappear from the user's view after a small interval. More...
 
void SendAlertToUser (IClientAPI client, string message, bool modal)
 Send an alert message to a particular user. More...
 
void SendAlertToUser (UUID agentID, string message)
 Send a non-modal alert message to a particular user. More...
 
void SendAlertToUser (UUID agentID, string message, bool modal)
 Send an alert message to a particular user. More...
 
void SendAlertToUser (string firstName, string lastName, string message, bool modal)
 Send an alert message to a particular user. More...
 
void SendGeneralAlert (string message)
 Send an alert message to all users in the scene. More...
 
void SendDialogToUser (UUID avatarID, string objectName, UUID objectID, UUID ownerID, string message, UUID textureID, int ch, string[] buttonlabels)
 Send a dialog box to a particular user. More...
 
void SendUrlToUser (UUID avatarID, string objectName, UUID objectID, UUID ownerID, bool groupOwned, string message, string url)
 Send a url to a particular user. More...
 
void SendNotificationToUsersInRegion (UUID fromAvatarID, string fromAvatarName, string message)
 Send a notification to all users in the scene. This notification should remain around until the user explicitly dismisses it. More...
 
void SendTextBoxToUser (UUID avatarid, string message, int chatChannel, string name, UUID objectid, UUID ownerid)
 Send a textbox entry for the client to respond to More...
 

Detailed Description

Definition at line 33 of file IDialogModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendAlertToUser ( IClientAPI  client,
string  message 
)

Send a non-modal alert message to a particular user. This can disappear from the user's view after a small interval.

Parameters
clientIClientAPI object representing the user.
messageMessage text to send to the user.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendAlertToUser ( IClientAPI  client,
string  message,
bool  modal 
)

Send an alert message to a particular user.

Parameters
clientIClientAPI object representing the user.
messageMessage text to send to the user.
modalFlag to control modality.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendAlertToUser ( UUID  agentID,
string  message 
)

Send a non-modal alert message to a particular user.

Parameters
agentIDUUID of agent representing the user.
messageMessage text to send to the user.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendAlertToUser ( UUID  agentID,
string  message,
bool  modal 
)

Send an alert message to a particular user.

Parameters
agentIDUUID of agent representing the user.
messageMessage text to send to the user.
modalFlag to control modality.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendAlertToUser ( string  firstName,
string  lastName,
string  message,
bool  modal 
)

Send an alert message to a particular user.

Parameters
firstNameAccount first name
lastNameAccount last name
messageMessage text to send to the user.
modalFlag to control modality.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendDialogToUser ( UUID  avatarID,
string  objectName,
UUID  objectID,
UUID  ownerID,
string  message,
UUID  textureID,
int  ch,
string[]  buttonlabels 
)

Send a dialog box to a particular user.

Parameters
avatarIDUUID of the avatar representing the user.
objectNameName of the object sending the dialog.
objectIDUUID of the object sending the dialog.
ownerIDUUID of the user that owns the object.
messageMessage text to send to the user.
textureIDTexture UUID to pass along with the dialog.
chChannel on which the selected button text should be broadcast.
buttonlabelsDialog button text.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendGeneralAlert ( string  message)

Send an alert message to all users in the scene.

Parameters
messageMessage text to send to all users.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendNotificationToUsersInRegion ( UUID  fromAvatarID,
string  fromAvatarName,
string  message 
)

Send a notification to all users in the scene. This notification should remain around until the user explicitly dismisses it.

On the Linden Labs Second Client (as of 1.21), this is a big blue box message on the upper right of the screen.

Parameters
fromAvatarIDThe user sending the message
fromAvatarNameThe name of the user doing the sending
messageThe message being sent to the user

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendTextBoxToUser ( UUID  avatarid,
string  message,
int  chatChannel,
string  name,
UUID  objectid,
UUID  ownerid 
)

Send a textbox entry for the client to respond to

Parameters
avatarIDUUID of the avatar representing the user.
messageMessage text to send to the user.
chatChannelChat channel that the user's input should be broadcast on.
nameName of the object sending the dialog.
objectidUUID of the object sending the dialog.
owneridUUID of the user that owns the object.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.

void OpenSim.Region.Framework.Interfaces.IDialogModule.SendUrlToUser ( UUID  avatarID,
string  objectName,
UUID  objectID,
UUID  ownerID,
bool  groupOwned,
string  message,
string  url 
)

Send a url to a particular user.

Parameters
avatarIDUUID of the avatar representing the user.
objectNameName of the object sending the dialog.
objectIDUUID of the object sending the dialog.
ownerIDUUID of the user that owns the object.
groupOwnedFlag indicating whether or not the object is group-owned.
messageMessage text to send to the user.
urlUrl to send to the user.

Implemented in OpenSim.Region.CoreModules.Avatar.Dialog.DialogModule.


The documentation for this interface was generated from the following file: