Web API

SiteBuilder

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

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

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Method Summary
SiteBuilder cacheFiles(String[] secure)

This will enable web caching for the specified extensions. Note: index.html is never cached. Pass an empty array to remove caching.

SiteBuilder deleteFile(String filename)

Deletes the specified file. After all changes are made call publish().

SiteBuilder deleteWorkflowPath(String path)

Deletes the path from being handled by workflow.

String[] getWorkflowPaths()

Shows workflow paths, if any.

SiteBuilder publish()

Publishes any changes made.

  publishWebApp(File zipFile)

Updates the content of this site with files contained in the zipFile. Throws exception if the resulting webapp exceeds max pal size. The zip must contain index.html. Other site settings (workflow paths, etc) remain intact. Any existing content files are replaced by this zipFile content.

SiteBuilder putFile(String filename, File file)

Puts the specified file into the site, over-riding any existing file with the same filename. . After all changes are made call publish().

  removeWebApp()

Removes the web app, if any, associated with this pal. After calling this method, calling any other method will re-create the web app.

SiteBuilder setSecure(boolean secure)

If true, this will force a redirect to https if the request is not already https.

SiteBuilder setWorkflowPath(String path)

Sets a path to be handled by workflow. The path is relative to the root and can end with a * for a wildcard.

String toString()

Returns a description of this object.

Method Detail


SiteBuilder cacheFiles(String[] secure)

This will enable web caching for the specified extensions. Note: index.html is never cached. Pass an empty array to remove caching.

Parameters:

  • String[]   secure Required parameter.

Returns:  SiteBuilder

Since: 08-02-2023

top

SiteBuilder deleteFile(String filename)

Deletes the specified file. After all changes are made call publish().

Parameters:

  • String   filename Required parameter.

Returns:  SiteBuilder

Since: 07-24-2023

top

SiteBuilder deleteWorkflowPath(String path)

Deletes the path from being handled by workflow.

Parameters:

  • String   path Required parameter.

Returns:  SiteBuilder

Since: 01-05-2024

top

String[] getWorkflowPaths()

Shows workflow paths, if any.

Returns:  String[]

Since: 01-05-2024

top

SiteBuilder publish()

Publishes any changes made.

Returns:  SiteBuilder

Since: 07-24-2023

top

publishWebApp(File zipFile)

Updates the content of this site with files contained in the zipFile. Throws exception if the resulting webapp exceeds max pal size. The zip must contain index.html. Other site settings (workflow paths, etc) remain intact. Any existing content files are replaced by this zipFile content.

Parameters:

  • File   zipFile Required parameter.

Since: 07-07-2023

top

SiteBuilder putFile(String filename, File file)

Puts the specified file into the site, over-riding any existing file with the same filename. . After all changes are made call publish().

Parameters:

  • String   filename Required parameter.
  • File   file Required parameter.

Returns:  SiteBuilder

Since: 07-24-2023

top

removeWebApp()

Removes the web app, if any, associated with this pal. After calling this method, calling any other method will re-create the web app.

Since: 07-07-2023

top

SiteBuilder setSecure(boolean secure)

If true, this will force a redirect to https if the request is not already https.

Parameters:

  • boolean   secure Required parameter.

Returns:  SiteBuilder

Since: 08-02-2023

top

SiteBuilder setWorkflowPath(String path)

Sets a path to be handled by workflow. The path is relative to the root and can end with a * for a wildcard.

Parameters:

  • String   path Required parameter.

Returns:  SiteBuilder

Since: 01-05-2024

top

String toString()

Returns a description of this object.

Returns:  String

Since: 07-07-2023

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM