Facsys AFM/SDK Solgenia® Facsys™ Fax Messaging/Routing Gateway
Software Development Kit (SDK)
AFM & Web Services

Download
SDK


Contact

   
Introduction Object Model Tasks Samples & Languages Packaging Troubleshooting FAQ Appendices
   

FaxCoverPage Object

The FaxCoverPage object represents a single fax cover page in a FaxCoverPages collection.

Properties

Name

Data Type

Access

Class

Long

Read-only

Parent

FaxCoverPages object

Read-only

Session

FaxSession object

Read-only

     

Created

Date

Read-only

FileName

String

Read-only

Index

Long

Read-only

IsDefault

Boolean

Read-only

IsSystemDefault

Boolean

Read-only

Modified

Date

Read-only

Shared

Boolean

Read-only

Title

String

Read-only

 

 

Methods

Name

Input Parameters

Return Values

Update

FileName as String

 

WriteToFile

FileName as String,
FailIfExists as Boolean

 
 

Back to Top

 

Created Property

The Created property returns the date and time the cover page was created. Read-only.

Syntax

ObjCoverPage.Created

Data Type

Date

Back to Top

 

FileName Property

The FileName property returns the full path and name of the actual cover page file. Read-only.

Syntax

ObjCoverPage.FileName

Data Type

String

Back to Top

 

Index Property

The Index property returns the index of the cover page object within its parent FaxCoverPages collection. The index reflects this cover page’s position within the parent collection. Read-only.

Syntax

ObjCoverPage.Index

Data Type

Long

Remarks

A cover page's index property may change if other cover page items are removed from the parent FaxCoverPages collection.

The first object in the collection has an Index value of 1.

Back to Top

 

IsDefault Property

The IsDefault property returns the user's "default" status of the fax cover page object Read-only.

Syntax

ObjCoverPage.IsDefault

Data Type

Boolean

Remarks

A non-zero value is returned if the fax cover page object is defned as the current user's default fax cover page.

Back to Top

 

IsSystemDefault Property

The IsSystemDefault property returns the system "default" status of the fax cover page object Read-only.

Syntax

ObjCoverPage.IsSystemDefault

Data Type

Boolean

Remarks

A non-zero value is returned if the fax cover page object is defined as the current server's default fax cover page.

Back to Top

 

Modified Property

The Modified property returns the date and time the cover page was last modified. Read-only.

Syntax

ObjCoverPage.Modified

Data Type

Date

Back to Top

 

Shared Property

The Shared property returns the cover page type. Read-only.

Syntax

ObjCoverPage.Shared

Data Type

Boolean

Remarks

A non-zero value is returned if the cover page is shared.

Back to Top

 

Title Property

The Title property returns the title assigned to the Facsys cover page. Read-only.

Syntax

ObjCoverPage.Title

Data Type

String

Back to Top

 

Update Method

The Update method updates the cover page file on the server with the filename you specify.

Syntax

ObjCoverPage.Update(FileName)

Back to Top

 

WriteToFile Method

The WriteToFile method copies the cover page file to the filename you specify.

Syntax

ObjCoverPage.WriteToFile(FileName,FailIfExists)

Remarks

The FailIfExists parameter is a Boolean flag. If the cover page file already exists, then the parameter will be returned as FALSE.

Back to Top

Session

Image

Constant Definitions

Error Codes


Common Properties

Folders

Folder

Messages

Message

Recipients

Recipient

Attachments

Attachment

Phonebooks

Phonebook

Containers

Container

Entries

Entry

Fields

Field

Coverpages

Coverpage

Users

User

Home  |  Solgenia  |  Facsys  |  Facsys Support  |  Download Request  |  Contact