io.openvidu.java.client

Class Connection

java.lang.Object

io.openvidu.java.client.Connection

public class Connection
extends Object

See Session.getActiveConnections()

Method Summary

Modifier and Type	Method and Description
long	createdAt() Timestamp when this connection was established, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)
String	getClientData() Returns the data associated to the connection on the client-side.
String	getConnectionId() Returns the identifier of the connection.
String	getLocation() Returns the geo location of the connection, with the following format: "CITY, COUNTRY" ("unknown" if it wasn't possible to locate it) (ONLY IN OPENVIDU PRO)
String	getPlatform() Returns a complete description of the platform used by the participant to connect to the session
List<Publisher>	getPublishers() Returns the list of Publisher objects this particular Connection is publishing to the Session (each Publisher object has one Stream, uniquely identified by its streamId).
OpenViduRole	getRole() Returns the role of the connection
String	getServerData() Returns the data associated to the connection on the server-side.
List<String>	getSubscribers() Returns the list of streams (their streamId properties) this particular Connection is subscribed to.
String	getToken() Returns the token associated to the connection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getConnectionId

public String getConnectionId()

Returns the identifier of the connection. You can call Session.forceDisconnect(String) passing this property as parameter

createdAt

public long createdAt()

Timestamp when this connection was established, in UTC milliseconds (ms since Jan 1, 1970, 00:00:00 UTC)

getRole

public OpenViduRole getRole()

Returns the role of the connection

getToken

public String getToken()

Returns the token associated to the connection

getLocation

public String getLocation()

Returns the geo location of the connection, with the following format: "CITY, COUNTRY" ("unknown" if it wasn't possible to locate it) (ONLY IN OPENVIDU PRO)

getPlatform

public String getPlatform()

Returns a complete description of the platform used by the participant to connect to the session

getServerData

public String getServerData()

Returns the data associated to the connection on the server-side. This value is set with TokenOptions.Builder.data(String) when calling Session.generateToken()

getClientData

public String getClientData()

Returns the data associated to the connection on the client-side. This value is set with second parameter of method Session.connect in OpenVidu Browser

getPublishers

public List<Publisher> getPublishers()

Returns the list of Publisher objects this particular Connection is publishing to the Session (each Publisher object has one Stream, uniquely identified by its streamId). You can call Session.forceUnpublish(Publisher) passing any of this values as parameter

getSubscribers

public List<String> getSubscribers()

Returns the list of streams (their streamId properties) this particular Connection is subscribed to. Each one always corresponds to one Publisher of some other Connection: each string of the returned list must be equal to the returned value of some Publisher.getStreamId()