Console API

TunnelResult

List of Classes

ConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

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

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
String get(String key)

Returns the specified value from of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
Data getData()

Returns the data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
Data getData(String data)

Returns the specified data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
DataList getDataList(String list)

Returns the specified datalist of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
String getError()

On failure, returns the failure message.
Payload getPayload()

Returns the payload result of the request, if any. This may return null if the remote workflow did not set a payload.
SafeBox getSafeBox()

Returns the SafeBox associated with this request, if any.
boolean isSuccess()

Returns true if the request is successful.
String toString()

Returns a description of this object.

Method Detail

String get(String key)

Returns the specified value from of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.

Parameters:

  • String   key

Returns:  String

Since: 07-02-2020

top
Data getData()

Returns the data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.

Returns:  Data

Since: 07-02-2020

top
Data getData(String data)

Returns the specified data of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.

Parameters:

  • String   data Required parameter.

Returns:  Data

Since: 07-02-2020

top
DataList getDataList(String list)

Returns the specified datalist of the payload result of the request, if any. This may return null if the remote workflow did not set a payload.

Parameters:

  • String   list Required parameter.

Returns:  DataList

Since: 07-02-2020

top
String getError()

On failure, returns the failure message.

Returns:  String

Since: 06-18-2018

top
Payload getPayload()

Returns the payload result of the request, if any. This may return null if the remote workflow did not set a payload.

Returns:  Payload

Since: 06-18-2018

top
SafeBox getSafeBox()

Returns the SafeBox associated with this request, if any.

Returns:  SafeBox

Since: 11-17-2022

top
boolean isSuccess()

Returns true if the request is successful.

Returns:  boolean

Since: 06-18-2018

top
String toString()

Returns a description of this object.

Returns:  String

Since: 06-18-2018

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