Socket

Other API in Package

Console Webservice

List of Classes

InternalConsoleController

AnalyticDataViewFilter

ChartSharedSettings

ConsoleResponse

DataViewBuilder

DataViewCriteria

DisplaySettings

DownloadResponse

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalWebAlias

InternalZoneManager

PacketDataRecord

PalActivationKeyInfo

ProfilePalManager

ProfileTxManager

ScatterPlotChart

ServiceResponse

ShellPalManager

SmartDocManager

StorageProvider

StorageProviderDataList

SystemDataViewFilter

TransactionPacket

TransactionUtil

WorkflowResponse

Provides functionality for working making direct workflow calls to web workflow or a plugin.

This class also used in (click to expand):

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: Nov 18, 2024 01:04 PM