Console System API

ClientSocketManager

Other API in Package

Console

Console Webservice

Internal Console

Provides functionality for working with ClientSockets.

Method Summary
ClientSocket createClientSocket(String channel, boolean secure, int renewalIncrement)

Creates a new ClientSocket that does not respond to inbound client requests.

ClientSocket createClientSocket(String receiverWorkflow, String channel, boolean secure, int renewalIncrement)

Creates a new ClientSocket. To keep a client alive you should have JavaScript brower code that sends a 'ping' message every 30 seconds. By default, idle sockets are closed after one minute.

  deleteClientSocket(String socketId)

Deletes the ClientSocket

ClientSocket getClientSocket(String socketId)

Returns settings set in Pal Manager.

SystemDataView getSockets()

Returns ClientSockets associated with this pal.

Method Detail


ClientSocket createClientSocket(String channel, boolean secure, int renewalIncrement)

Creates a new ClientSocket that does not respond to inbound client requests.

Parameters:

  • String   channel  - Name of channel, can be anything. Maximum allowed size of parameter: 255
  • boolean   secure  - If true, we will restrict to the IP address of the current browser session..
  • int   renewalIncrement  - How many minutes to renew on each request. Maximum allowed size of parameter: 30

Returns:  ClientSocket

Since: 06-04-2026

top

ClientSocket createClientSocket(String receiverWorkflow, String channel, boolean secure, int renewalIncrement)

Creates a new ClientSocket. To keep a client alive you should have JavaScript brower code that sends a 'ping' message every 30 seconds. By default, idle sockets are closed after one minute.

Parameters:

  • String   receiverWorkflow  - Console system workflow to run on message event. Messages are handled asynchronously.. Maximum allowed size of parameter: 255
  • String   channel  - Name of channel, can be anything. Maximum allowed size of parameter: 255
  • boolean   secure  - If true, we will restrict to the IP address of the current browser session..
  • int   renewalIncrement  - How many minutes to renew on each request. Maximum allowed size of parameter: 30

Returns:  ClientSocket

Since: 06-04-2026

top

deleteClientSocket(String socketId)

Deletes the ClientSocket

Parameters:

  • String   socketId

Since: 06-04-2026

top

ClientSocket getClientSocket(String socketId)

Returns settings set in Pal Manager.

Parameters:

  • String   socketId

Returns:  ClientSocket

Since: 06-04-2026

top

SystemDataView getSockets()

Returns ClientSockets associated with this pal.

Returns:  SystemDataView

Since: 06-04-2026

top
Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. API Date: Jun 12, 2026 11:29 AM