Console Webservice API

Chunk

Other API in Package

Console

Console System

Internal Console

List of Classes

ConsoleWebServiceController

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

ConsolePacket

ConsoleWebServiceRequest

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

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

WebServiceResponse

Wizard

XMLReader

ZoneAccess

A chunk is a pre-rendered and cached portion of HTML.

Method Summary
  addData(Data data)

Adds the data to the chunk.
  addDataList(DataList list)

Adds the datalist to the chunk.
  addDataMap(String id, Data data)

Adds the data to the chunk with the specified id.
  addPayload(Payload payload)

Adds the payload to the chunk.
  cache(int expires)

Renders and caches the chunk. Over-rides anything that already exists with the ID.
  setFragment(Fragment fragment)

Sets the fragment to the chunk.
  setStatic(String content)

Sets the static content of the chunk. Only allowed in the web workflow engine unless enabled at the cloud level.
  setValue(String key, String value)

Adds the key/value to the chunk.
String toString()

Returns a description of this object.

Method Detail

addData(Data data)

Adds the data to the chunk.

Parameters:

Since: 12-15-2017

top
addDataList(DataList list)

Adds the datalist to the chunk.

Parameters:

Since: 12-15-2017

top
addDataMap(String id, Data data)

Adds the data to the chunk with the specified id.

Parameters:

  • String   id Required parameter.
  • Data   data

Since: 01-12-2018

top
addPayload(Payload payload)

Adds the payload to the chunk.

Parameters:

Since: 12-15-2017

top
cache(int expires)

Renders and caches the chunk. Over-rides anything that already exists with the ID.

Parameters:

  • int   expires  - Time in minutes. Pass -1 for indefinite cache.. Required parameter.

Since: 12-15-2017

top
setFragment(Fragment fragment)

Sets the fragment to the chunk.

Parameters:

  • Fragment   fragment Required parameter.

Since: 12-15-2017

top
setStatic(String content)

Sets the static content of the chunk. Only allowed in the web workflow engine unless enabled at the cloud level.

Parameters:

  • String   content Required parameter.

Since: 12-21-2020

top
setValue(String key, String value)

Adds the key/value to the chunk.

Parameters:

  • String   key
  • String   value

Since: 12-15-2017

top
String toString()

Returns a description of this object.

Returns:  String

Since: 12-15-2017

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