Internal Console API

InternalPalStoreItem extends InternalPalStoreInfo

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
InternalPalStoreInvite addOwnerAffiliateInvite(int available)

Adds a new affiliate invitation. Available must be greater than 0.

InternalPalStoreInvite addOwnerResellerInvite(int available)

Adds a new reseller invitation. Available must be greater than 0.

  approve()

Approves this item.

  deleteInvite(String inviteId)

Deletes the specified invitation.

  disable()

Disables this item- making it no longer visible from the store.

  enable()

Approves this item.

String getAudience()

Returns the intended audience.

Data getData()

Returns information on this PalStoreItem as a Data object.

SystemDataView getEnterpriseInstallations()

Returns a SystemDataView that can be used for accessing enterprise installations for this item.

InternalKeyFeatures getFeatures()

Returns the feature information.

int getInstallCount()

Returns the number of installs of this store item.

String getInstallType()

Returns the installation type.

String getInstallWorkflow()

Returns the intended audience.

SystemDataView getInvitations()

Returns a SystemDataView that can be used for accessing invitations for this item.

InternalPalStoreInvite getInvite(String inviteCode)

Returns the specified Invite

PalInfo getPalInfo()

Returns the activation key requirements for this item.

InternalKeyPricing getPricing()

Returns the pricing information.

String getStoreId()

Returns the store id.

int getTrialPeriod()

Returns the trial period in days. 0 means no trial period.

String getUpgradeType()

Returns the upgrade type.

String getVersion()

Returns the current version of this store item, which may not be the same version as the underlying Pal.

InternalZone getZone()

Returns the zone information (read-only).

boolean hasInstall(String profileId)

Returns true if the active user's enterprise has an install of this store.

boolean hasSubscription(String profileId)

Returns true if the active user has a subscription to the given store for the specified profile.

boolean hasTransactionAccess(String profileId)

Returns true if the active user's enterprise has an install of the given store and the user has transaction access.

boolean isAutomaticUpgrade()

Returns true if the upgrade type is automatic.

boolean isComplete()

Returns true if the install type is complete.

boolean isEnterprise()

Returns true if the intended audience is enterprise.

boolean isFeatured()

Returns true if the store item is featured.

boolean isLinked()

Returns true if the install type is linked.

boolean isManualUpgrade()

Returns true if the upgrade type is manual.

boolean isPersonal()

Returns true if the intended audience is personal.

boolean isPrivateInvite()

Returns true the store item is private invitation.

boolean isRepository()

Returns true if the install type is repository.

boolean isSubscription()

Returns true if the install type is subscription.

boolean isVersioned()

Returns true if the Pal is versioned.

  reject()

Rejects this item.

boolean setFeatured(boolean featured)

Sets or removed featured status. To be featured, a store item must be public (not private invite).

String toString()

Returns a description of this object.

Method Detail


InternalPalStoreInvite addOwnerAffiliateInvite(int available)

Adds a new affiliate invitation. Available must be greater than 0.

Parameters:

  • int   available

Returns:  InternalPalStoreInvite

Since: 05-18-2010

top

InternalPalStoreInvite addOwnerResellerInvite(int available)

Adds a new reseller invitation. Available must be greater than 0.

Parameters:

  • int   available

Returns:  InternalPalStoreInvite

Since: 05-18-2010

top

approve()

Approves this item.

Since: 08-11-2009

top

deleteInvite(String inviteId)

Deletes the specified invitation.

Parameters:

  • String   inviteId

Since: 09-14-2009

top

disable()

Disables this item- making it no longer visible from the store.

Since: 09-02-2009

top

enable()

Approves this item.

Since: 09-02-2009

top

String getAudience()

Returns the intended audience.

Returns:  String

Since: 07-14-2009

top

Data getData()

Returns information on this PalStoreItem as a Data object.

Returns:  Data

Since: 07-14-2009

top

SystemDataView getEnterpriseInstallations()

Returns a SystemDataView that can be used for accessing enterprise installations for this item.

Returns:  SystemDataView


DataList Name: EnterpriseInstallations
DataList Keys/Column Name Column Type Read Only
enterprise String  
createDate Date  
modifiedDate Date  
version String  
module Boolean  
storeId String  
installType String  
upgradeType String  
cancelDate Date  
currentVersion String  
lastModified String  

Since: 03-23-2015

top

InternalKeyFeatures getFeatures()

Returns the feature information.

Returns:  InternalKeyFeatures

Since: 05-18-2010

top

int getInstallCount()

Returns the number of installs of this store item.

Returns:  int

Since: 07-14-2009

top

String getInstallType()

Returns the installation type.

Returns:  String

Since: 07-14-2009

top

String getInstallWorkflow()

Returns the intended audience.

Returns:  String

Since: 07-14-2009

top

SystemDataView getInvitations()

Returns a SystemDataView that can be used for accessing invitations for this item.

Returns:  SystemDataView


DataList Name: Invites
DataList Keys/Column Name Column Type Read Only
inviteCode String  
storeId String  
available Number  
used Number  
remaining Number  
type String  
enterpriseName String  
keyName String  

Since: 09-14-2009

top

InternalPalStoreInvite getInvite(String inviteCode)

Returns the specified Invite

Parameters:

  • String   inviteCode

Returns:  InternalPalStoreInvite

Since: 09-14-2009

top

PalInfo getPalInfo()

Returns the activation key requirements for this item.

Returns:  PalInfo

Since: 09-25-2009

top

InternalKeyPricing getPricing()

Returns the pricing information.

Returns:  InternalKeyPricing

Since: 05-18-2010

top

String getStoreId()

Returns the store id.

Returns:  String

Since: 09-02-2009

top

int getTrialPeriod()

Returns the trial period in days. 0 means no trial period.

Returns:  int

Since: 07-14-2009

top

String getUpgradeType()

Returns the upgrade type.

Returns:  String

Since: 07-14-2009

top

String getVersion()

Returns the current version of this store item, which may not be the same version as the underlying Pal.

Returns:  String

Since: 06-28-2011

top

InternalZone getZone()

Returns the zone information (read-only).

Returns:  InternalZone

Since: 11-11-2010

top

boolean hasInstall(String profileId)

Returns true if the active user's enterprise has an install of this store.

Parameters:

  • String   profileId

Returns:  boolean

Since: 07-14-2009

top

boolean hasSubscription(String profileId)

Returns true if the active user has a subscription to the given store for the specified profile.

Parameters:

  • String   profileId

Returns:  boolean

Since: 07-14-2009

top

boolean hasTransactionAccess(String profileId)

Returns true if the active user's enterprise has an install of the given store and the user has transaction access.

Parameters:

  • String   profileId

Returns:  boolean

Since: 07-14-2009

top

boolean isAutomaticUpgrade()

Returns true if the upgrade type is automatic.

Returns:  boolean

Since: 10-15-2009

top

boolean isComplete()

Returns true if the install type is complete.

Returns:  boolean

Since: 10-08-2009

top

boolean isEnterprise()

Returns true if the intended audience is enterprise.

Returns:  boolean

Since: 07-14-2009

top

boolean isFeatured()

Returns true if the store item is featured.

Returns:  boolean

Since: 07-07-2010

top

boolean isLinked()

Returns true if the install type is linked.

Returns:  boolean

Since: 10-15-2009

top

boolean isManualUpgrade()

Returns true if the upgrade type is manual.

Returns:  boolean

Since: 10-15-2009

top

boolean isPersonal()

Returns true if the intended audience is personal.

Returns:  boolean

Since: 07-14-2009

top

boolean isPrivateInvite()

Returns true the store item is private invitation.

Returns:  boolean

Since: 07-14-2009

top

boolean isRepository()

Returns true if the install type is repository.

Returns:  boolean

Since: 10-08-2009

top

boolean isSubscription()

Returns true if the install type is subscription.

Returns:  boolean

Since: 10-15-2009

top

boolean isVersioned()

Returns true if the Pal is versioned.

Returns:  boolean

Since: 07-14-2009

top

reject()

Rejects this item.

Since: 08-11-2009

top

boolean setFeatured(boolean featured)

Sets or removed featured status. To be featured, a store item must be public (not private invite).

Parameters:

  • boolean   featured

Returns:  boolean

Since: 07-07-2010

top

String toString()

Returns a description of this object.

Returns:  String

Since: 07-14-2009

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