Integration Server 10.11 | Built-In Services Reference Guide | WebSocket Folder | Summary of Elements in this Folder | pub.websocket:getCookies
 
pub.websocket:getCookies
WmPublic: Retrieves the cookies that are part of the HTTP request to establish a WebSocket connection.
Input Parameters
sessionId
String Session ID for the WebSocket session for which you want to retrieve the cookies information.
Output Parameters
cookies
Document List- Conditional. List of the cookies that are part of the HTTP request to establish a WebSocket connection. This parameter returns value only if cookies were part of the request.
Key
Description
name
String The name of the cookie.
comment
String Description about the purpose of the cookie. This parameter returns null if the cookie has no comment.
commentURL
String The comment URL which describes the purpose of the cookie. This parameter returns null if the cookie has no comment.
discard
String The value of the discard attribute for the cookie.
domain
String The domain name set for the given cookies.
maxAge
String The maximum age of the cookie specified in seconds.
path
String The path on the server to which the browser returns the cookie.
portlist
String The value of the port list attribute of the cookie.
secure
String Indicates whether sending the cookie is restricted to a secure protocol or any protocol.
*True Sending the cookie is restricted to a secure protocol.
*False The cookie can be sent using any protocol.
value
String The value of the cookie.
version
String The version of the protocol with which the cookie complies.