Internal Console API

User

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 canAccessConsolePal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

boolean canAccessTransaction(String txId, boolean anon)

Returns true if the user can access the specified transaction. Anon only has meaning if the user is currently logged in on a personal profile. This method could return false for the following reasons: (a) the user does not have a role on the transaction, (b) the user had access (role access) at one time but deleted the access, (c) the user is on an enterprise profile and does not have role or group access to the transaction.

boolean canAccessTransactionPal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

String createSessionToken()

Returns a session token for manipulating user information by system tunnel workflow. Returns null if the user is not on their personal profile.

DataList getEnterpriseProfiles()

Returns a list of enterprise profiles including id and name. This returns an empty list if the user does not have any enterprise profiles.

String getLastAction()

Returns the last action for this user on this pal, which might be null.

Profile getPersonalProfile()

Returns the user's personal profile.

Profile getProfile()

Returns the user's profile.

boolean isEmailRegistered(String emailAddress)

Returns true if the user is associated with the specified email address.

boolean isRestricted()

Returns true if this user has authenticated via an SSO process and is restricted as to what can be accessed in this session.

  refresh()

Forces a storage reload on the user information.

String toString()

Returns a description of this object.

VCardFile toVCardFile(String fileName)

Exports this user information to business card file. Information is based on personal profile. Profile information access permission rules apply

boolean validateAccount(String code)

Returns true if the code matches a code previously generated in the current session. See Message and Email setValidationCode methods.

Method Detail


boolean canAccessConsolePal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

Parameters:

  • String   palId
  • String   profileId

Returns:  boolean

Since: 09-03-2009

top

boolean canAccessTransaction(String txId, boolean anon)

Returns true if the user can access the specified transaction. Anon only has meaning if the user is currently logged in on a personal profile. This method could return false for the following reasons: (a) the user does not have a role on the transaction, (b) the user had access (role access) at one time but deleted the access, (c) the user is on an enterprise profile and does not have role or group access to the transaction.

Parameters:

  • String   txId
  • boolean   anon

Returns:  boolean

Since: 07-14-2009

top

boolean canAccessTransactionPal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

Parameters:

  • String   palId
  • String   profileId

Returns:  boolean

Since: 09-03-2009

top

String createSessionToken()

Returns a session token for manipulating user information by system tunnel workflow. Returns null if the user is not on their personal profile.

Returns:  String

Since: 01-27-2021

top

DataList getEnterpriseProfiles()

Returns a list of enterprise profiles including id and name. This returns an empty list if the user does not have any enterprise profiles.

Returns:  DataList


DataList Name: profiles
DataList Fields: id, name, enterprise, system, support, defaultProfile, createDate, lastAccess

Since: 08-28-2009

top

String getLastAction()

Returns the last action for this user on this pal, which might be null.

Returns:  String

Since: 11-03-2016

top

Profile getPersonalProfile()

Returns the user's personal profile.

Returns:  Profile

Since: 08-28-2009

top

Profile getProfile()

Returns the user's profile.

Returns:  Profile

Since: 12-31-2008

top

boolean isEmailRegistered(String emailAddress)

Returns true if the user is associated with the specified email address.

Parameters:

  • String   emailAddress  - Email Address. Required parameter.

Returns:  boolean

Since: 07-07-2010

top

boolean isRestricted()

Returns true if this user has authenticated via an SSO process and is restricted as to what can be accessed in this session.

Returns:  boolean

Since: 05-20-2021

top

refresh()

Forces a storage reload on the user information.

Since: 01-27-2021

top

String toString()

Returns a description of this object.

Returns:  String

Since: 12-31-2008

top

VCardFile toVCardFile(String fileName)

Exports this user information to business card file. Information is based on personal profile. Profile information access permission rules apply

Parameters:

  • String   fileName  - file name. Should have .vcf or .vcard extension. If not, .vcf extension will be appended. Required parameter.

Returns:  VCardFile

Since: 12-13-2011

top

boolean validateAccount(String code)

Returns true if the code matches a code previously generated in the current session. See Message and Email setValidationCode methods.

Parameters:

  • String   code

Returns:  boolean

Since: 04-27-2009

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