Package org.xwiki.netflux
Class EntityChannel
- java.lang.Object
-
- org.xwiki.netflux.EntityChannel
-
public class EntityChannel extends Object
A channel associated to an XWiki entity.- Since:
- 13.9RC1
- Version:
- $Id: 3c2e75c3262504f619d3089792a3f1fb6cc246fd $
-
-
Constructor Summary
Constructors Constructor Description EntityChannel(org.xwiki.model.reference.EntityReference entityReference, List<String> path, String key)
Creates a new channel.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.xwiki.model.reference.EntityReference
getEntityReference()
String
getKey()
List<String>
getPath()
int
getUserCount()
void
setUserCount(int userCount)
Sets the number of users connected to the channel.
-
-
-
Constructor Detail
-
EntityChannel
public EntityChannel(org.xwiki.model.reference.EntityReference entityReference, List<String> path, String key)
Creates a new channel.- Parameters:
entityReference
- the entity this channel is associated withpath
- the channel path, used to identify the channel among all the channels associated to the same entitykey
- the channel key
-
-
Method Detail
-
getEntityReference
public org.xwiki.model.reference.EntityReference getEntityReference()
- Returns:
- the entity associated with this channel
-
getPath
public List<String> getPath()
- Returns:
- the channel path, used to identify the channel among all the channels associated to the same entity
-
getKey
public String getKey()
- Returns:
- the channel key
-
getUserCount
public int getUserCount()
- Returns:
- the number of users connected to the channel
-
setUserCount
public void setUserCount(int userCount)
Sets the number of users connected to the channel.- Parameters:
userCount
- the new user count
-
-