Namespace: roomApi

roomApi

Room api based on core api
Source:

Namespaces

Room
RoomSession

Methods

(static) connect(options) → {roomApi.RoomSession}

Initialize connection
Parameters:
Name Type Description
options Object session options
Properties
Name Type Attributes Description
urlServer String Server address in form of [ws,wss]://host.domain:port
username String Username to login with
token String JWT Token
appKey String Application Key
timeout Integer <optional>
 Connection timeout in milliseconds [0]
pingInterval Integer <optional>
 Server ping interval in milliseconds [0]
receiveProbes Integer <optional>
 A maximum subsequental pings received missing count [0]
probesInterval Integer <optional>
 Interval to check subsequental pings received [0]
Source:
Returns:
Type
roomApi.RoomSession