Skip to main content

Displaying User Messages

  • Updated

Displaying User Messages

Some Server Events are designed to display messages to the user based on a return value. For the other server events a user message can be displayed by throwing the WebReports.Api.Common.WrUserMessage(string, wrUSerMessageType) method.

light bulb

This method can be used for all server events except OnConfigLoadStart, OnConfigLoadEnd and OnExceptionThrown

WrUserMessage(string messageOrId, wrUserMessageType Type)

DescriptionDisplays a message to the user.
Arguments
  • messageOrId: either a message string, or a language file ID that contains the message content. Set the value of the type argument accordingly.
  • type: a value from the wrUserMessageType enumeration, that determines if the messageOrId argument should be treated as a string literal with the message content, or should be used to look up a matching language file ID.
Example
Example of wrUserMessage
//OnWebServiceExecuteEnd, inspect the returned value and throw
// a message if it matches any of the error messages.
object webServiceResult = args[0];
switch(webServiceResult.ToString())
{
	case "message1" : throw new WrUserMessage("Some Message to User", WrUserMessageType.Text);
}
return webServiceResult;