Class Index | File Index

Classes


Namespace faces.push

faces.push
Defined in: faces.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
faces.push.close(channel)
Close the web socket on the given channel.
<inner>  
<inner>  
getSocket(channelToken)
Get socket associated with given channelToken.
<static>  
faces.push.open(channel)
Open the web socket on the given channel.
Namespace Detail
faces.push
Method Detail
<static> faces.push.close(channel)
Close the web socket on the given channel.
Parameters:
{string} channel
The name of the web socket channel.
Throws:
{Error}
When channel is unknown.

<inner> getBaseURL(url)
Parameters:
url

<inner> {Socket} getSocket(channelToken)
Get socket associated with given channelToken.
Parameters:
{string} channelToken
The name of the web socket channelToken.
Throws:
{Error}
When channelToken is unknown, you may need to initialize it first via init() function.
Returns:
{Socket} Socket associated with given channelToken.

<static> faces.push.open(channel)
Open the web socket on the given channel.
Parameters:
{string} channel
The name of the web socket channel.
Throws:
{Error}
When channel is unknown.

Documentation generated by JsDoc Toolkit 2.1.0 on Tue Jan 24 2023 20:40:03 GMT-0500 (EST)