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.
- Source:
Classes
Type Definitions
appCallback(errnullable, appObjnullable)
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 | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Error object. If it is null, than assume no error has occurred. |
appObj |
Object |
<nullable> |
Application object. Will be null if an error has occurred. |
- Source:
connectionCallback(errnullable, connectionObjnullable)
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 | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Error object. If it is null, than assume no error has occurred. |
connectionObj |
Object |
<nullable> |
Connection object. Will be null if an error has occurred. |
- Source:
Error
An error object
Type:
- Object
- Source:
nextCallback(errnullable)
The next callback is called upon completion of a method. If the `err` parameter is null, than the method completed successfully.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Optional Error object. If it is null, than assume no error has occurred. |
- Source:
roomCallback(errnullable, roomObjnullable)
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 | Attributes | Description |
---|---|---|---|
err |
Error |
<nullable> |
Error object. If it is null, than assume no error has occurred. |
roomObj |
Object |
<nullable> |
Room object. Will be null if an error has occurred. |
- Source: