Internal Transaction API

InternalDomainManager

List of Classes

InternalTransactionController

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

InternalAcmeService

InternalCloudSubscriptionManager

InternalDevelopmentPal

InternalDomainManager

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

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
boolean addDomain(String domainName)

Creates a new domain. domainName must be valid according to the RFC specification and the TLD must be registered on this cloud.
boolean addGlobalDomain(String domainName)

Creates a new domain without checking for exclusivity. The cloud must enable multiple enterprises to register the same domain.
InternalWebAlias createWebAlias(String aliasCname, String aliasDomain, String host)

Creates an alias for the specified host.
boolean deleteDomain(String id)

Deletes the specified domain.
  deleteWebAlias(String id)

Deletes the alias with the given id.
SystemDataView getDomains()

Returns a list of domains for this enterprise.
InternalWebAlias getWebAlias(String id)

Returns the alias with the given id.
SystemDataView getWebAliases()

Returns a list of web aliases for this enterprise.
SystemDataView getWebPals()

Returns a list of deployed web pals for this enterprise.
boolean isDomainUnique(String domainName)

Returns true if the domain is unique.
boolean isGlobalEnabled()

Returns true if this cloud permits global domains.
boolean setDomainActive(String id, boolean active)

Sets the active flag for the specified domain.
String toString()

Returns a description of this object.

Method Detail

boolean addDomain(String domainName)

Creates a new domain. domainName must be valid according to the RFC specification and the TLD must be registered on this cloud.

Parameters:

  • String   domainName  - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 09-22-2015

top
boolean addGlobalDomain(String domainName)

Creates a new domain without checking for exclusivity. The cloud must enable multiple enterprises to register the same domain.

Parameters:

  • String   domainName  - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 01-27-2021

top
InternalWebAlias createWebAlias(String aliasCname, String aliasDomain, String host)

Creates an alias for the specified host.

Parameters:

  • String   aliasCname  - aliasCname, for example * or cname or blank for root. Maximum allowed size of parameter: 255
  • String   aliasDomain  - aliasDomain, for example mysite.com. Required parameter. Maximum allowed size of parameter: 255
  • String   host  - host of the alias, for example www.actualsite.com. Required parameter. Maximum allowed size of parameter: 255

Returns:  InternalWebAlias

Since: 03-02-2010

top
boolean deleteDomain(String id)

Deletes the specified domain.

Parameters:

  • String   id Required parameter.

Returns:  boolean

Since: 04-05-2010

top
deleteWebAlias(String id)

Deletes the alias with the given id.

Parameters:

  • String   id Required parameter.

Since: 03-02-2010

top
SystemDataView getDomains()

Returns a list of domains for this enterprise.

Returns:  SystemDataView


DataList Name: Domains
DataList Keys/Column Name Column Type Read Only
id String  
domainName String  
active Boolean  

Since: 03-02-2010

top
InternalWebAlias getWebAlias(String id)

Returns the alias with the given id.

Parameters:

  • String   id Required parameter.

Returns:  InternalWebAlias

Since: 03-02-2010

top
SystemDataView getWebAliases()

Returns a list of web aliases for this enterprise.

Returns:  SystemDataView


DataList Name: WebAliases
DataList Keys/Column Name Column Type Read Only
id String  
alias String  
host String  
redirect Boolean  

Since: 03-02-2010

top
SystemDataView getWebPals()

Returns a list of deployed web pals for this enterprise.

Returns:  SystemDataView


DataList Name: WebPals
DataList Keys/Column Name Column Type Read Only
palId String  
name String  
host String  
modifiedDate Date  
firstName String  
lastName String  
email String  

Since: 03-02-2010

top
boolean isDomainUnique(String domainName)

Returns true if the domain is unique.

Parameters:

  • String   domainName  - domain name. Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 03-02-2010

top
boolean isGlobalEnabled()

Returns true if this cloud permits global domains.

Returns:  boolean

Since: 01-27-2021

top
boolean setDomainActive(String id, boolean active)

Sets the active flag for the specified domain.

Parameters:

  • String   id Required parameter.
  • boolean   active

Returns:  boolean

Since: 04-05-2010

top
String toString()

Returns a description of this object.

Returns:  String

Since: 03-02-2010

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