Console API

JSONBuffer

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

Provides the ability to build a JSON string from platform objects.

Method Summary
JSONBuffer endArray()

Ends an array node.

JSONBuffer endObject()

Ends an object node.

JSONBuffer key(String name)

Starts an object node with the given name.

JSONBuffer preserveType(boolean boolean)

If true, Data operations will attempt to have type guessed and added accordingly (rather than being a string always).

JSONBuffer set(String key, String value)

Adds the key/value pair to the buffer.

JSONBuffer setBoolean(String name, Boolean value)

Adds the key/value pair to the buffer.

JSONBuffer setBooleans(Boolean[] items)

Adds the item(s) to the array node in this buffer.

JSONBuffer setData(Data data)

Adds the Data to this buffer.

JSONBuffer setData(String name, Data data)

Adds the Data to this buffer with the given key.

JSONBuffer setDataList(DataList datalist)

Adds the datalist to the buffer.

JSONBuffer setDate(String name, Date value)

Adds the key/value pair to the buffer.

JSONBuffer setDates(Date[] items)

Adds the item(s) to the array node in this buffer.

JSONBuffer setDouble(String name, Number double)

Adds the key/value pair to the buffer.

JSONBuffer setInt(String name, Number value)

Adds the key/value pair to the buffer.

JSONBuffer setInts(Number[] items)

Adds the item(s) to the array node in this buffer.

JSONBuffer setLong(String name, Number value)

Adds the key/value pair to the buffer.

JSONBuffer setPayload(Payload payload)

Adds the payload to the buffer.

JSONBuffer setRecord(DataViewRecord record)

Adds the DataViewRecord to this buffer, preserving field types.

JSONBuffer setRecord(String name, DataViewRecord record)

Adds the DataViewRecord to this buffer with the given key, preserving field types.

JSONBuffer setString(String name, String value)

Adds the key/value pair to the buffer.

JSONBuffer setStrings(String[] items)

Adds the item(s) to the array node in this buffer.

JSONBuffer startArray()

Starts an array node.

JSONBuffer startObject()

Starts an object node.

String toString()

Returns the final JSON object as a string.

JSONBuffer value(String json)

Adds a JSON encoded string to this buffer.

Method Detail


JSONBuffer endArray()

Ends an array node.

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer endObject()

Ends an object node.

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer key(String name)

Starts an object node with the given name.

Parameters:

  • String   name Required parameter.

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer preserveType(boolean boolean)

If true, Data operations will attempt to have type guessed and added accordingly (rather than being a string always).

Parameters:

  • boolean   boolean

Returns:  JSONBuffer

Since: 09-22-2023

top

JSONBuffer set(String key, String value)

Adds the key/value pair to the buffer.

Parameters:

  • String   key Required parameter.
  • String   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setBoolean(String name, Boolean value)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • Boolean   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setBooleans(Boolean[] items)

Adds the item(s) to the array node in this buffer.

Parameters:

  • Boolean[]   items Required parameter.

Returns:  JSONBuffer

Since: 11-15-2023

top

JSONBuffer setData(Data data)

Adds the Data to this buffer.

Parameters:

Returns:  JSONBuffer

Since: 06-22-2022

top

JSONBuffer setData(String name, Data data)

Adds the Data to this buffer with the given key.

Parameters:

  • String   name
  • Data   data

Returns:  JSONBuffer

Since: 06-22-2022

top

JSONBuffer setDataList(DataList datalist)

Adds the datalist to the buffer.

Parameters:

  • DataList   datalist Required parameter.

Returns:  JSONBuffer

Since: 09-22-2023

top

JSONBuffer setDate(String name, Date value)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • Date   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setDates(Date[] items)

Adds the item(s) to the array node in this buffer.

Parameters:

  • Date[]   items Required parameter.

Returns:  JSONBuffer

Since: 11-15-2023

top

JSONBuffer setDouble(String name, Number double)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • Number   double

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setInt(String name, Number value)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • Number   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setInts(Number[] items)

Adds the item(s) to the array node in this buffer.

Parameters:

  • Number[]   items Required parameter.

Returns:  JSONBuffer

Since: 11-15-2023

top

JSONBuffer setLong(String name, Number value)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • Number   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setPayload(Payload payload)

Adds the payload to the buffer.

Parameters:

  • Payload   payload Required parameter.

Returns:  JSONBuffer

Since: 09-22-2023

top

JSONBuffer setRecord(DataViewRecord record)

Adds the DataViewRecord to this buffer, preserving field types.

Parameters:

Returns:  JSONBuffer

Since: 05-09-2022

top

JSONBuffer setRecord(String name, DataViewRecord record)

Adds the DataViewRecord to this buffer with the given key, preserving field types.

Parameters:

Returns:  JSONBuffer

Since: 05-09-2022

top

JSONBuffer setString(String name, String value)

Adds the key/value pair to the buffer.

Parameters:

  • String   name Required parameter.
  • String   value

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer setStrings(String[] items)

Adds the item(s) to the array node in this buffer.

Parameters:

  • String[]   items Required parameter.

Returns:  JSONBuffer

Since: 11-15-2023

top

JSONBuffer startArray()

Starts an array node.

Returns:  JSONBuffer

Since: 04-29-2022

top

JSONBuffer startObject()

Starts an object node.

Returns:  JSONBuffer

Since: 04-29-2022

top

String toString()

Returns the final JSON object as a string.

Returns:  String

Since: 04-29-2022

top

JSONBuffer value(String json)

Adds a JSON encoded string to this buffer.

Parameters:

  • String   json

Returns:  JSONBuffer

Since: 04-29-2022

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM