SessionConnectProperties class

Properties

A class that defines the properties parameter of the connect() method of a Session object.

See Session.connect().

SessionConnectProperties properties

The SessionConnectProperties class includes the following properties:

connectionData (String) — A string containing metadata describing the connection. For example, this may be the user ID, name, or other data describing the connection.

detectConnectionQuality (Number) — Set this to either 0 or 1:

• Setting the detectConnectionQuality property to 0 means that the quality property of the Session's connection property will not be set.
• Setting the detectConnectionQuality property to 1 means that the quality property of the Session object's connection property will be set. The quality property of the connection property of the Session object includes information about the downstream bandwith, the upstream bandwidth, and the latency at the time of the connection. (See Connection.)