Console API

Attachment

List of Classes

ConsoleController

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

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
String getContentType()

Returns the content type of this attachment

String getCreator()

Returns creator name for this Attachment

String getDescription()

Returns the description of this attachment

DisplaySettings getDisplaySettings()

Returns the DisplaySettings for this Attachment

String getFileExtension()

Returns file extension for this attachment

int getFileSize()

Returns the size of this attachment in KB

String getFilename()

Returns file name for this attachment

String getId()

Returns the id of this attachment

Date getLastModifiedDate()

Returns last modification time stamp for this Attachment

String getLastModifier()

Returns last modifier name for this Attachment

String getName()

Returns the name of this attachment

boolean isClean()

Returns true if this attachment was checked for viruses or macros and contains none.

boolean isDataListSupported()

Returns true if this attachment can be converted to a DataList

boolean isHTMLConversionSupported()

Returns true if this attachment can be converted to HTML. Currently supported: doc, docx, rtf, odt.

boolean isPdfConversionSupported()

Returns true if the content supports conversion to PDF.

  setDescription(String description)

Sets the description of this attachment

  setName(String name)

Sets the name of this attachment

PacketDataList toDataList(String name)

Creates a non persistent PacketDataList from the contents of this attachment. The contents must support DataList conversion (currently .csv and .xls)

File toFile()

Returns contents of this attachment as file object

String toString()

Returns a description of this object.

boolean updateContent(File file)

Returns true if this attachment is successfully updated with the file content.

Method Detail


String getContentType()

Returns the content type of this attachment

Returns:  String

Since: 11-18-2008

top

String getCreator()

Returns creator name for this Attachment

Returns:  String

Since: 09-08-2009

top

String getDescription()

Returns the description of this attachment

Returns:  String

Since: 11-18-2008

top

DisplaySettings getDisplaySettings()

Returns the DisplaySettings for this Attachment

Returns:  DisplaySettings

Since: 03-06-2009

top

String getFileExtension()

Returns file extension for this attachment

Returns:  String

Since: 03-31-2010

top

int getFileSize()

Returns the size of this attachment in KB

Returns:  int

Since: 11-18-2008

top

String getFilename()

Returns file name for this attachment

Returns:  String

Since: 03-31-2010

top

String getId()

Returns the id of this attachment

Returns:  String

Since: 08-19-2009

top

Date getLastModifiedDate()

Returns last modification time stamp for this Attachment

Returns:  Date

Since: 09-08-2009

top

String getLastModifier()

Returns last modifier name for this Attachment

Returns:  String

Since: 09-08-2009

top

String getName()

Returns the name of this attachment

Returns:  String

Since: 11-18-2008

top

boolean isClean()

Returns true if this attachment was checked for viruses or macros and contains none.

Returns:  boolean

Since: 02-23-2010

top

boolean isDataListSupported()

Returns true if this attachment can be converted to a DataList

Returns:  boolean

Since: 01-14-2010

top

boolean isHTMLConversionSupported()

Returns true if this attachment can be converted to HTML. Currently supported: doc, docx, rtf, odt.

Returns:  boolean

Since: 09-08-2009

top

boolean isPdfConversionSupported()

Returns true if the content supports conversion to PDF.

Returns:  boolean

Since: 01-28-2009

top

setDescription(String description)

Sets the description of this attachment

Parameters:

  • String   description

Since: 09-09-2009

top

setName(String name)

Sets the name of this attachment

Parameters:

  • String   name

Since: 09-09-2009

top

PacketDataList toDataList(String name)

Creates a non persistent PacketDataList from the contents of this attachment. The contents must support DataList conversion (currently .csv and .xls)

Parameters:

  • String   name

Returns:  PacketDataList

Since: 01-14-2010

top

File toFile()

Returns contents of this attachment as file object

Returns:  File

Since: 05-10-2011

top

String toString()

Returns a description of this object.

Returns:  String

Since: 11-18-2008

top

boolean updateContent(File file)

Returns true if this attachment is successfully updated with the file content.

Parameters:

Returns:  boolean

Since: 01-07-2010

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