Transaction System API

ClientSocketManager

List of Classes

CommonController

TransactionSystemController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ClientSocket

ClientSocketManager

ConsoleManager

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Provides functionality for working with ClientSockets.

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

Creates a new ClientSocket.
  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 workflow, String channel, boolean secure, int renewalIncrement)

Creates a new ClientSocket.

Parameters:

  • String   workflow  - Console system workflow to run on message event.. 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 06, 2026 03:29 PM