com.vaadin.flow.server.communication.rpc.NavigationRpcHandler API 14.3.7 | Vaadin

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

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

java.lang.Object
- com.vaadin.flow.server.communication.rpc.NavigationRpcHandler

All Implemented Interfaces:

RpcInvocationHandler, Serializable
```
public class NavigationRpcHandler
extends Object
implements RpcInvocationHandler
```
RPC handler for Navigation.

Since:

1.0

Author:

Vaadin Ltd

See Also:

JsonConstants.RPC_TYPE_NAVIGATION, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NavigationRpcHandler()

Method Summary

All Methods
Modifier and Type	Method and Description
`String`	`getRpcType()` Gets unique RPC type which this handler is applicable for.
`Optional<Runnable>`	`handle(UI ui, elemental.json.JsonObject invocationJson)` Handles RPC data `invocationJson` using `ui` as a context.

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

- Constructor Detail
  - NavigationRpcHandler
```
public NavigationRpcHandler()
```
- Method Detail
  - getRpcType
```
public String getRpcType()
```
    Description copied from interface: RpcInvocationHandler
    
    Gets unique RPC type which this handler is applicable for.
    
    Specified by:
    
    getRpcType in interface RpcInvocationHandler
    
    Returns:
    
    the unique rpc type
  - handle
```
public Optional<Runnable> handle(UI ui,
                                 elemental.json.JsonObject invocationJson)
```
    Description copied from interface: RpcInvocationHandler
    
    Handles RPC data invocationJson using ui as a context.
    
    Specified by:
    
    handle in interface RpcInvocationHandler
    
    Parameters:
    
    ui - the UI to handle against, not null
    
    invocationJson - the RPC data to handle, not null
    
    Returns:
    
    an optional runnable