com.vaadin.flow.server.communication.MetadataWriter API 12.0.0.alpha5 | Vaadin

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

com.vaadin.flow.server.communication.

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

All Implemented Interfaces:

Serializable
```
public class MetadataWriter
extends Object
implements Serializable
```
Serializes miscellaneous metadata to JSON.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetadataWriter()

Method Summary

All Methods
Modifier and Type	Method and Description
`elemental.json.JsonObject`	`createMetadata(UI ui, boolean repaintAll, boolean async, SystemMessages messages)` Creates a JSON object containing metadata related to the given UI.

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

- Constructor Detail
  - MetadataWriter
```
public MetadataWriter()
```
- Method Detail
  - createMetadata
```
public elemental.json.JsonObject createMetadata(UI ui,
                                                boolean repaintAll,
                                                boolean async,
                                                SystemMessages messages)
```
    Creates a JSON object containing metadata related to the given UI.
    
    Parameters:
    
    ui - The UI whose metadata to write.
    
    repaintAll - Whether the client should repaint everything.
    
    async - True if this message is sent by the server asynchronously, false if it is a response to a client message.
    
    messages - a SystemMessages containing client-side error messages.
    
    Returns:
    
    JSON object with the metadata