com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler API 23.0.16 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.8.0 for the latest.

com.vaadin.flow.server.communication.rpc.

java.lang.Object
- com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
- - com.vaadin.flow.server.communication.rpc.PublishedServerEventHandlerRpcHandler

All Implemented Interfaces:

RpcInvocationHandler, Serializable
```
public class PublishedServerEventHandlerRpcHandler
extends AbstractRpcInvocationHandler
```
RPC handler for events triggered through element.$server or simply $server in template event handlers.
For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

JsonConstants.RPC_PUBLISHED_SERVER_EVENT_HANDLER, Serialized Form

Constructor Summary

Constructors
Constructor Description

PublishedServerEventHandlerRpcHandler()

Method Summary

All Methods
Modifier and Type	Method	Description
`protected boolean`	`allowInert(StateNode node)`
`String`	`getRpcType()`	Gets unique RPC type which this handler is applicable for.
`Optional<Runnable>`	`handleNode(StateNode node, elemental.json.JsonObject invocationJson)`	Handle the RPC data `invocationJson` using target `node` as a context.

Methods inherited from class com.vaadin.flow.server.communication.rpc.AbstractRpcInvocationHandler
allowInvocationWhileInert, handle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PublishedServerEventHandlerRpcHandler
```
public PublishedServerEventHandlerRpcHandler()
```
- Method Detail
  - getRpcType
```
public String getRpcType()
```
    Description copied from interface: RpcInvocationHandler
    
    Gets unique RPC type which this handler is applicable for.
    
    Returns:
    
    the unique rpc type
  - allowInert
```
protected boolean allowInert(StateNode node)
```
    Overrides:
    
    allowInert in class AbstractRpcInvocationHandler
  - handleNode
```
public Optional<Runnable> handleNode(StateNode node,
                                     elemental.json.JsonObject invocationJson)
```
    Description copied from class: AbstractRpcInvocationHandler
    
    Handle the RPC data invocationJson using target node as a context.
    
    Specified by:
    
    handleNode in class AbstractRpcInvocationHandler
    
    Parameters:
    
    node - node to handle invocation with, not null
    
    invocationJson - the RPC data to handle, not null
    
    Returns:
    
    an optional runnable