Public interface for interacting with EasyRTC. Contains the public object returned by the EasyRTC listen() function.
- Copyright:
-
- Copyright 2016 Priologic Software. All rights reserved.
- License:
-
- BSD v2, see LICENSE file in module root folder.
Classes
Type Definitions
-
appCallback(err, appObj)
-
The application callback is called upon completion of a method which is meant to deliver an application object. If the `err` parameter is null, than the method completed successfully.
Parameters:
Name Type Argument Description errError <nullable>
Error object. If it is null, than assume no error has occurred. appObjObject <nullable>
Application object. Will be null if an error has occurred. -
connectionCallback(err, connectionObj)
-
The connection callback is called upon completion of a method which is meant to deliver a connection object. If the `err` parameter is null, than the method completed successfully.
Parameters:
Name Type Argument Description errError <nullable>
Error object. If it is null, than assume no error has occurred. connectionObjObject <nullable>
Connection object. Will be null if an error has occurred. -
Error
-
An error object
Type:
- Object
-
nextCallback(err)
-
The next callback is called upon completion of a method. If the `err` parameter is null, than the method completed successfully.
Parameters:
Name Type Argument Description errError <nullable>
Optional Error object. If it is null, than assume no error has occurred. -
roomCallback(err, roomObj)
-
The room callback is called upon completion of a method which is meant to deliver a room object. If the `err` parameter is null, than the method completed successfully.
Parameters:
Name Type Argument Description errError <nullable>
Error object. If it is null, than assume no error has occurred. roomObjObject <nullable>
Room object. Will be null if an error has occurred.