|
|
Provides functionality for making direct workflow calls to web workflow or a plugin.
Method DetailSocket setAction(String action) Action or the event.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setController(CommonController controller) Sets the current controller on this socket.
Parameters:
Returns: Socket Since: 04-16-2026 Socket setCookie(String name, String value) For a web socket, sends a cookie with the call, as if the browser had it: the web workflow reads it with request.getCookie(name). Name cannot start with cp- or jsession. A null value removes the cookie from this socket.
Parameters:
Returns: Socket Since: 11-10-2026 Socket setCookies(Data cookies) For a web socket, sends every name and value of the data as a cookie, see setCookie.
Parameters:
Returns: Socket Since: 11-10-2026 Socket setData(Data data) Sets the data.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setHeaders(Data headers) For a web socket, this sets the given http headers.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setJson(String json) Sets json.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setMethod(String method) For a web socket, for example, this should be 'get' or 'post'.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setPath(String path) For a web socket, this sets the given path, e.g. /thepath.
Parameters:
Returns: Socket Since: 11-04-2023 Socket setPayload(Payload payload) Sets the payload on this socket.
Parameters:
Returns: Socket Since: 04-16-2026 Socket setSessionValue(String name, String value) For a web socket, gives the web workflow a session value to start with: it reads it with request.getSessionValue(name). Name cannot start with cp-. Name and value are limited to 200 characters. A null value removes the value from this socket. Each call to submit has its own session, nothing is carried over from a previous call.
Parameters:
Returns: Socket Since: 11-10-2026 Socket setSessionValues(Data values) For a web socket, gives the web workflow every name and value of the data as a session value, see setSessionValue.
Parameters:
Returns: Socket Since: 11-10-2026 Socket setWorkflow(String workflow) Workflow to run (web pal only).
Parameters:
Returns: Socket Since: 11-04-2023 SocketResponse submit() Submits to the socket endpoint. Returns: SocketResponse Since: 11-04-2023 String toString() Returns a description of this object. Returns: String Since: 11-04-2023 |
||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. | API Date: Nov 10, 2026 09:54 AM |