Integration Server 10.5 | Built-In Services Reference Guide | WebSocket Folder | Summary of Elements in this Folder | pub.websocket:ping
 
pub.websocket:ping
WmPublic: Sends a ping message containing the given application data to the remote endpoint after establishing the connection.
Input Parameters
sessionId
String Required. Session ID for the WebSocket session for which you want to send the ping message.
applicationData
String Optional. The application data to be sent as part of the ping message. If the parameter value is null an empty buffer will be sent.
charset
String Optional. The character encoding. If the parameter value is null, the default character set is used.
Output Parameters
pinged
String Indicates the success or failure of the ping message. This parameter returns a value of true if the ping message is received successfully. Else the parameter returns the value false.