Namespace faces.push
				
			
				faces.push
				
				
					
Defined in:  faces.js.
				
			
| Constructor Attributes | Constructor Name and Description | 
|---|---|
| Method Attributes | Method Name and Description | 
|---|---|
| <static> | faces.push.close(channel)
								 Close the web socket on the given channel. | 
| <inner> | getBaseURL(url)
								 | 
| <inner> | getSocket(channelToken)
								 Get socket associated with given channelToken. | 
| <static> | faces.push.init(onopen, onmessage, onerror, onclose, autoconnect, onerror, onclose, behaviorScripts, autoconnect)
								 | 
| <static> | faces.push.open(channel)
								 Open the web socket on the given channel. | 
					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.init(onopen, onmessage, onerror, onclose, autoconnect, onerror, onclose, behaviorScripts, autoconnect)
					
					
					- Parameters:
- {function} onopen
- The function to be invoked when the web socket is opened.
- {function} onmessage
- The function to be invoked when a message is received.
- {function} onerror
- The function to be invoked when the web socket throws a error.
- {function} onclose
- The function to be invoked when the web socket is closed.
- {boolean} autoconnect
- Whether or not to immediately open the socket. Defaults to false.
- onerror
- onclose
- behaviorScripts
- autoconnect
<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.