ChannelMessage (formcycle: bom 8.3.4 API)

java.lang.Object
- de.xima.fc.gui.common.model.push.ChannelMessage

All Implemented Interfaces:

Serializable
```
public class ChannelMessage
extends Object
implements Serializable
```
A message sent to the client via a web socket. Contains an event name that identifies the type message, and a payload with additional details.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  ChannelMessage(String eventName, Serializable payload)
  Creates a new channel message with the given data.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String getEventName()
  
  Object getPayload()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChannelMessage
```
public ChannelMessage(String eventName,
                      Serializable payload)
```
    Creates a new channel message with the given data.
    
    Parameters:
    
    eventName - Name of the message event.
    
    payload - Data of the message event.
- Method Detail
  - getEventName
```
public String getEventName()
```
    Returns:
    
    Name (type) of the message event.
  - getPayload
```
public Object getPayload()
```
    Returns:
    
    Data that is sent along with the message.