Console System API

Socket

Other API in Package

Console

Console Webservice

Internal Console

List of Classes

ConsoleSystemController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsolePacket

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 making direct workflow calls to web workflow or a plugin.

Method Summary
Socket setAction(String action)

Action or the event.
Socket setData(Data data)

Sets the data.
Socket setHeaders(Data headers)

For a web socket, this sets the given http headers.
Socket setJson(String json)

Sets json.
Socket setMethod(String method)

For a web socket, for example, this should be 'get' or 'post'.
Socket setPath(String path)

For a web socket, this sets the given path, e.g. /thepath.
Socket setWorkflow(String workflow)

Workflow to run (web pal only).
SocketResponse submit()

Submits to the socket endpoint.
String toString()

Returns a description of this object.

Method Detail

Socket setAction(String action)

Action or the event.

Parameters:

  • String   action Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setData(Data data)

Sets the data.

Parameters:

  • Data   data Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setHeaders(Data headers)

For a web socket, this sets the given http headers.

Parameters:

  • Data   headers Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setJson(String json)

Sets json.

Parameters:

  • String   json Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setMethod(String method)

For a web socket, for example, this should be 'get' or 'post'.

Parameters:

  • String   method Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setPath(String path)

For a web socket, this sets the given path, e.g. /thepath.

Parameters:

  • String   path Required parameter.

Returns:  Socket

Since: 11-04-2023

top
Socket setWorkflow(String workflow)

Workflow to run (web pal only).

Parameters:

  • String   workflow Required parameter.

Returns:  Socket

Since: 11-04-2023

top
SocketResponse submit()

Submits to the socket endpoint.

Returns:  SocketResponse

Since: 11-04-2023

top
String toString()

Returns a description of this object.

Returns:  String

Since: 11-04-2023

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM