Package ro.sync.ecss.extensions.api.webapp

Class WebappMessage

java.lang.Object

ro.sync.ecss.extensions.api.webapp.WebappMessage

Direct Known Subclasses:

UserActionRequiredMessage

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class WebappMessage
extends Object

Webapp server message that is presented on client side.

Since:

16.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MESSAGE_TYPE_CUSTOM	A message type that is the lowest designed to be intercepted by the plugin code on the client side and displayed in a custom way.
static final int	MESSAGE_TYPE_ERROR	Message type error.
static final int	MESSAGE_TYPE_INFO	Message type info.
static final int	MESSAGE_TYPE_RESULT_VALUE	This message represents a return value from an WebappAuthorOperation.
static final int	MESSAGE_TYPE_SYSTEM_APPLICATION	A message type that should be handled by the webapp to open the url in the system application as it cannot be opened server-side.
static final int	MESSAGE_TYPE_WARN	Message type warning.

Constructor Summary

Constructors

Constructor	Description
WebappMessage(int type, String title, String message, boolean isUserGenerated)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getMessage()
String	getTitle()
int	getType()
int	hashCode()
boolean	isUserGenerated()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MESSAGE_TYPE_RESULT_VALUE

public static final int MESSAGE_TYPE_RESULT_VALUE

This message represents a return value from an WebappAuthorOperation.

See Also:

• Constant Field Values

MESSAGE_TYPE_SYSTEM_APPLICATION

public static final int MESSAGE_TYPE_SYSTEM_APPLICATION

A message type that should be handled by the webapp to open the url in the system application as it cannot be opened server-side.

See Also:

• Constant Field Values

MESSAGE_TYPE_INFO

public static final int MESSAGE_TYPE_INFO

Message type info.

See Also:

• Constant Field Values

MESSAGE_TYPE_WARN

public static final int MESSAGE_TYPE_WARN

Message type warning.

See Also:

• Constant Field Values

MESSAGE_TYPE_ERROR

public static final int MESSAGE_TYPE_ERROR

Message type error.

See Also:

• Constant Field Values

MESSAGE_TYPE_CUSTOM

public static final int MESSAGE_TYPE_CUSTOM

A message type that is the lowest designed to be intercepted by the plugin code on the client side and displayed in a custom way. All message types larger than this one are not handled by default by the webapp, but passed to the plugin code handlers.

See Also:

• Constant Field Values

Constructor Details

WebappMessage

public WebappMessage(int type,
 String title,
 String message,
 boolean isUserGenerated)

Constructor.

Parameters:

type - Message type.

title - Message title.

message - Message body.

isUserGenerated - true if the message was generated by the user and should be presented in UI.

Method Details

getMessage

public String getMessage()

Returns:

Returns the message.

getTitle

public String getTitle()

Returns:

Returns the title.

getType

public int getType()

Returns:

Returns the type.

isUserGenerated

public boolean isUserGenerated()

Returns:

Returns the isUserGenerated.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()