Web API

SmartDocManager

Other API in Package

User

Internal Tunnel

Tunnel

List of Classes

WebController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

ConsoleManager

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

GeoUtil

GroupConcat

ImageFile

Inspector

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

Modules

Monitor

NavigatorResponse

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Pin

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Response

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

Tunnel

TunnelResult

UnknownFile

VCardFile

Validator

ValidityCheck

Wizard

XMLReader

ZoneAccess

Provides functionality for working with SmartDocs.

Method Summary
SmartDoc createPalSmartDoc(String name, String description, String category)

Creates a smart doc that is accessible to the Pal.
SmartDoc createPrivateSmartDoc(String name, String description, String category)

Creates a smart doc that is accessible to the Pal and the active user's profile.
int deletePrivateSmartDocs(String profileId)

Deletes all smart docs associated with the given profile.
  deleteSmartDoc(String id)

Deletes the specified smart doc.
SystemDataView getPalSmartDocs()

Returns a view of smart docs associated with this Pal with access level=Pal.
SystemDataView getPrivateSmartDocs()

Returns a view of smart docs associated with this Pal with access level=Private.
SmartDoc getSmartDoc(String id)

Returns the specified smart doc.
SystemDataView getSmartDocs()

Returns a view of smart docs associated with this Pal regardless of access level.
String toString()

Returns a description of this object.

Method Detail

SmartDoc createPalSmartDoc(String name, String description, String category)

Creates a smart doc that is accessible to the Pal.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80
  • String   description Required parameter. Maximum allowed size of parameter: 80
  • String   category Required parameter. Maximum allowed size of parameter: 80

Returns:  SmartDoc

Since: 06-28-2012

top
SmartDoc createPrivateSmartDoc(String name, String description, String category)

Creates a smart doc that is accessible to the Pal and the active user's profile.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 80
  • String   description Required parameter. Maximum allowed size of parameter: 80
  • String   category Required parameter. Maximum allowed size of parameter: 80

Returns:  SmartDoc

Since: 06-28-2012

top
int deletePrivateSmartDocs(String profileId)

Deletes all smart docs associated with the given profile.

Parameters:

  • String   profileId Required parameter.

Returns:  int

Since: 06-28-2012

top
deleteSmartDoc(String id)

Deletes the specified smart doc.

Parameters:

  • String   id Required parameter.

Since: 06-28-2012

top
SystemDataView getPalSmartDocs()

Returns a view of smart docs associated with this Pal with access level=Pal.

Returns:  SystemDataView


DataList Name: PalSmartDocs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
name String  
description String  
category String  
status String  
createDate Date  
modifiedDate Date  

Since: 06-28-2012

top
SystemDataView getPrivateSmartDocs()

Returns a view of smart docs associated with this Pal with access level=Private.

Returns:  SystemDataView


DataList Name: PrivateSmartDocs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
name String  
description String  
category String  
status String  
createDate Date  
modifiedDate Date  

Since: 06-28-2012

top
SmartDoc getSmartDoc(String id)

Returns the specified smart doc.

Parameters:

  • String   id Required parameter.

Returns:  SmartDoc

Since: 06-28-2012

top
SystemDataView getSmartDocs()

Returns a view of smart docs associated with this Pal regardless of access level.

Returns:  SystemDataView


DataList Name: SmartDocs
Tag Support: No
DataList Keys/Column Name Column Type Read Only
id String  
name String  
description String  
category String  
status String  
createDate Date  
modifiedDate Date  

Since: 06-28-2012

top
String toString()

Returns a description of this object.

Returns:  String

Since: 06-28-2012

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM