Internal Console API

InternalKey

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

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

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

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
boolean approve()

Approves the key using the settings of the pseudo key. The pseudo key must have already been approved.

boolean associateInvite(String inviteCode)

Associates this key with the store item identified by inviteCode.

Data getAllData()

Returns a Data object containing information on this activation key, features, and pricing.

Data getData()

Returns a Data object containing information on this activation key.

InternalKeyFeatures getFeatures()

Returns the features for this activation key.

String getId()

Returns the ID of the key

InternalEnterprise getOwnerEnterprise()

Returns the enterprise associated with this Activation. Returns null if no enterprise is associated.

DataList getPals(boolean includeTxCount, boolean includeConsoleCount)

Returns a DataList of all Pals associated with this activation key.

InternalKeyPricing getPricing()

Returns the pricing for this activation key.

InternalPseudoKey getPseudoKey()

Returns the InternalPseudoKey for this InternalKey.

boolean isAffiliate()

Returns true if the key is an affiliate key.

boolean isApproved()

Returns true if the key has been approved.

boolean isGlobal()

Returns true if the key is a global key.

boolean isInProgress()

Returns true if the key status is in progress.

boolean isLinked()

Returns true if the key is a linked key.

boolean isReseller()

Returns true if the key is a reseller key.

boolean isRevoked()

Returns true if the key has been revoked

boolean removeInvite(String inviteCode)

Removes this key from the store item identified by inviteCode.

boolean revoke()

Sets the status of the activation key to revoked, preventing the creation of new transactions. Returns false if it fails for any reason.

  setNextChangeDate(Date date, String description)

Sets (or removes if null) the next change date.

Method Detail


boolean approve()

Approves the key using the settings of the pseudo key. The pseudo key must have already been approved.

Returns:  boolean

Since: 08-27-2008

top

boolean associateInvite(String inviteCode)

Associates this key with the store item identified by inviteCode.

Parameters:

  • String   inviteCode Required parameter.

Returns:  boolean

Since: 05-20-2010

top

Data getAllData()

Returns a Data object containing information on this activation key, features, and pricing.

Returns:  Data

Since: 05-13-2010

top

Data getData()

Returns a Data object containing information on this activation key.

Returns:  Data

Since: 03-09-2010

top

InternalKeyFeatures getFeatures()

Returns the features for this activation key.

Returns:  InternalKeyFeatures

Since: 05-06-2010

top

String getId()

Returns the ID of the key

Returns:  String

Since: 03-08-2010

top

InternalEnterprise getOwnerEnterprise()

Returns the enterprise associated with this Activation. Returns null if no enterprise is associated.

Returns:  InternalEnterprise

Since: 05-19-2010

top

DataList getPals(boolean includeTxCount, boolean includeConsoleCount)

Returns a DataList of all Pals associated with this activation key.

Parameters:

  • boolean   includeTxCount
  • boolean   includeConsoleCount

Returns:  DataList


DataList Name: pals
DataList Fields: id, name, test, modeConsole, modeTransaction, modeWeb, modeStore, modeUser, repository, txCount, consoleCount, linked, shadow, enterpriseName

Since: 09-17-2007

top

InternalKeyPricing getPricing()

Returns the pricing for this activation key.

Returns:  InternalKeyPricing

Since: 05-06-2010

top

InternalPseudoKey getPseudoKey()

Returns the InternalPseudoKey for this InternalKey.

Returns:  InternalPseudoKey

Since: 03-10-2010

top

boolean isAffiliate()

Returns true if the key is an affiliate key.

Returns:  boolean

Since: 05-13-2010

top

boolean isApproved()

Returns true if the key has been approved.

Returns:  boolean

Since: 09-17-2007

top

boolean isGlobal()

Returns true if the key is a global key.

Returns:  boolean

Since: 05-17-2019

top

boolean isInProgress()

Returns true if the key status is in progress.

Returns:  boolean

Since: 03-09-2010

top

boolean isLinked()

Returns true if the key is a linked key.

Returns:  boolean

Since: 05-17-2010

top

boolean isReseller()

Returns true if the key is a reseller key.

Returns:  boolean

Since: 05-13-2010

top

boolean isRevoked()

Returns true if the key has been revoked

Returns:  boolean

Since: 09-17-2007

top

boolean removeInvite(String inviteCode)

Removes this key from the store item identified by inviteCode.

Parameters:

  • String   inviteCode Required parameter.

Returns:  boolean

Since: 05-20-2010

top

boolean revoke()

Sets the status of the activation key to revoked, preventing the creation of new transactions. Returns false if it fails for any reason.

Returns:  boolean

Since: 09-17-2007

top

setNextChangeDate(Date date, String description)

Sets (or removes if null) the next change date.

Parameters:

  • Date   date  - change date.
  • String   description Maximum allowed size of parameter: 100

Since: 06-07-2010

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