Internal Console API

InternalCloudSubscriptionService

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 alertSubscriber(String palId, String service, Payload payload, String workflow)

Alerts the specified subscriber of the given notice.

  block(String palId, String emailAddress, String reason)

Blocks sending to the email address.

Data getNextEmailBlock(boolean flagAsNotified)

Returns the next (chronological) email block, flagging it as notified. The data contains these properties: email, statusCode, reason, blocks, resets, palId, palName. Returns null if no more blocks.

SystemDataView getSubscribers(String service)

Provides access to subscribers for the given service.

boolean isSubscriber(String palId, String service)

Returns true if the specified Pal is a subscriber to the given service.

String toString()

Returns a description of this object.

Method Detail


boolean alertSubscriber(String palId, String service, Payload payload, String workflow)

Alerts the specified subscriber of the given notice.

Parameters:

  • String   palId Required parameter.
  • String   service Required parameter. Allowed values: DSN, REPLY, EBLOCK.
  • Payload   payload Required parameter.
  • String   workflow

Returns:  boolean

Since: 12-11-2013

top

block(String palId, String emailAddress, String reason)

Blocks sending to the email address.

Parameters:

  • String   palId Required parameter.
  • String   emailAddress Required parameter.
  • String   reason Required parameter.

Since: 04-29-2019

top

Data getNextEmailBlock(boolean flagAsNotified)

Returns the next (chronological) email block, flagging it as notified. The data contains these properties: email, statusCode, reason, blocks, resets, palId, palName. Returns null if no more blocks.

Parameters:

  • boolean   flagAsNotified Required parameter.

Returns:  Data

Since: 01-12-2016

top

SystemDataView getSubscribers(String service)

Provides access to subscribers for the given service.

Parameters:

  • String   service Required parameter. Allowed values: DSN, REPLY, EBLOCK.

Returns:  SystemDataView


DataList Name: SystemSubscribers
DataList Keys/Column Name Column Type Read Only
subscriptionId String  
name String  
createDate Date  
palId String  
palName String  

Since: 12-11-2013

top

boolean isSubscriber(String palId, String service)

Returns true if the specified Pal is a subscriber to the given service.

Parameters:

  • String   palId Required parameter.
  • String   service Required parameter. Allowed values: DSN, REPLY, EBLOCK.

Returns:  boolean

Since: 04-28-2014

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-11-2013

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