com.vaadin.flow.server.communication.UidlWriter API 10.0.25 | Vaadin

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

com.vaadin.flow.server.communication.

java.lang.Object
- com.vaadin.flow.server.communication.UidlWriter

All Implemented Interfaces:

Serializable
```
public class UidlWriter
extends Object
implements Serializable
```
Serializes pending server-side changes to UI state to JSON. This includes shared state, client RPC invocations, connector hierarchy changes, connector type information among others.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class and Description
  
  static class UidlWriter.ResolveContext
  Provides context information for the resolve operations.
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  UidlWriter()
- Method Summary
  
  All Methods
  Modifier and Type Method and Description
  
  elemental.json.JsonObject createUidl(UI ui, boolean async)
  Creates a JSON object containing all pending changes to the given UI.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UidlWriter
```
public UidlWriter()
```
- Method Detail
  - createUidl
```
public elemental.json.JsonObject createUidl(UI ui,
                                            boolean async)
```
    Creates a JSON object containing all pending changes to the given UI.
    
    Parameters:
    
    ui - The UI whose changes to write
    
    async - True if this message is sent by the server asynchronously, false if it is a response to a client message.
    
    Returns:
    
    JSON object containing the UIDL response