com.vaadin.collaborationengine.TopicConnection API 23.1.17 | Vaadin

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

com.vaadin.collaborationengine.

java.lang.Object
- com.vaadin.collaborationengine.TopicConnection

```
public class TopicConnection
extends Object
```
API for sending and subscribing to updates between clients collaborating on the same collaboration topic.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

All Methods
Modifier and Type	Method	Description
`CollaborationList`	`getNamedList(String name)`	Gets a collaboration list that can be used to track a list of items in a single topic.
`CollaborationMap`	`getNamedMap(String name)`	Gets a collaboration map that can be used to track multiple values in a single topic.
`UserInfo`	`getUserInfo()`	Gets the user who is related to this topic connection.

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

- Method Detail
  - getUserInfo
```
public UserInfo getUserInfo()
```
    Gets the user who is related to this topic connection.
    
    Returns:
    
    the related user, not null
    
    Since:
    
    1.0
  - getNamedMap
```
public CollaborationMap getNamedMap(String name)
```
    Gets a collaboration map that can be used to track multiple values in a single topic.
    
    Parameters:
    
    name - the name of the map
    
    Returns:
    
    the collaboration map, not null
    
    Since:
    
    1.0
  - getNamedList
```
public CollaborationList getNamedList(String name)
```
    Gets a collaboration list that can be used to track a list of items in a single topic.
    
    Parameters:
    
    name - the name of the list
    
    Returns:
    
    the collaboration list, not null