FAXCOM FAXCOMLib Samples Guide

FAXCOMLib%20Samples%20Guide

User Manual: Pdf

Open the PDF directly: View PDF PDF.
Page Count: 10

DownloadFAXCOM FAXCOMLib Samples Guide
Open PDF In BrowserView PDF
FAXCOM .NET Class Library
Samples Guide
Version 10.1.1.26

Biscom, Incorporated
321 Billerica Road
Chelmsford, MA 01824
Main:
Fax:
Home Page:
Sales e-mail:

1-978-250-1800
1-978-250-4449
http://www.biscom.com
sales@biscom.com

Technical Support:
Technical Support e-mail:

1-978-250-8355
support@biscom.com

Copyright  Biscom, Inc., 1995 – 2015

Notice
Information furnished by BISCOM, Inc. is believed to be accurate and reliable. However, no
responsibility is assumed by BISCOM, Inc. for its use, nor any infringement of patents or other
rights of third parties which may result from its use. No license is granted by implication or
otherwise under any patent or patent rights of BISCOM. BISCOM reserves the right to change
hardware and software at any time without notice. Information provided in this manual is
subject to change without notice.

1. Introduction ...................................................................................................... 1
2. Deployment ...................................................................................................... 1
3. Console Applications ........................................................................................ 1
3.1 SendFax .................................................................................................... 1
3.2 MonitorStatuses ......................................................................................... 2
3.3 ReceiveFaxes............................................................................................. 3
3.4 EventMonitor............................................................................................ 4
4. UI Application ................................................................................................... 5
4.1 ClientShell .................................................................................................. 5
5. .NET Controls ................................................................................................... 6
5.1 ActivityCtl.................................................................................................... 6
5.2 PendingCtl .................................................................................................. 6
5.3 PendingGrid ............................................................................................... 7
5.4 ReceiveCtl .................................................................................................. 7
5.5 SentCtl ....................................................................................................... 7

Figures
Figure 1.
Figure 2.
Figure 3.
Figure 4.
Figure 5.

SendFax Sample Run ........................................................................... 2
MonitorStatuses Sample Run ............................................................... 3
ReceiveFaxes Sample Run .................................................................. 4
EventMonitor Sample Run .................................................................... 5
FAXCOMClient Sample Screen ............................................................ 6

iii

1. Introduction

This document describes a set of samples that illustrate the uses of the
FAXCOM .NET class library functionality.
There are three sets of samples:
1. A group of console applications that show how to login to the FAXCOM
queue, send a fax, monitor fax statuses, and receive faxes.
2. A sample client application showing how to integrate faxing with a GUI
application.
3. A set of simple .NET controls to show how to encapsulate faxing with UI.

2. Deployment

The FAXCOM .NET Class Library (FAXCOMLIB) depends on the FaxComApi
(FCApi.DLL). The FaxComApi needs to be installed for applications using this
FAXCOMLIB to run. The installers for the FaxComApi are distributed in the
FAXCOM SDK, as the files FCAPIsetup.exe and FCAPIsetupx64.exe. These
files are found in the directory C:\Program Files (x86)\Biscom\SDK\ if the SDK
was installed to the default path.
You also need to reference the three dlls located in: SDK\API for .NET\Bin. Once
they are included in the project, set Embed interop types to false for all three files
(You can access this setting by right-clicking each file and selecting Properties.)

3. Console Applications

There are four console applications written in C#. They are located in:
\Program Files\Biscom\SDK\API for .NET\Samples

(assuming you chose the default location for the installation).
Load the FAXCOMLib Samples solution (FAXCOMLib Samples.sln) using Visual
Studio 2010 and build the solution.

3.1 SendFax

The sample is located in :
\Program Files\Biscom\SDK\API for .NET\Samples\SendFax

(assuming you chose the default location for the installation).
The directory contains two files: SendFax.cs and SendFax.csproj.
The project is included in the solution provided.
This console application enables you to:
1. Login to the FAXCOM Queue.
2. Set the minimum information needed to send a fax.
3. Submit the fax.
4. Logout and exit the application.

1

Figure 1. SendFax Sample Run

3.2 MonitorStatuses
The sample is located in:

\Program Files\Biscom\SDK\API for .NET\Samples\MonitorStatuses

(assuming you chose the default location for the installation).
The directory contains two files: MonitorStatus.cs and MonitorStatuses.csproj.
The project is included in the solution provided.
This console application enables you to:
1. Login to the FAXCOM Queue.
2. Retrieve the Message Status Collection.
3. Retrieve a Message status that matches a IDTag provided.
4. If the Message status has not been received yet, wait a second and try
again until the status is found.
5. Once it is found, display data from the message status.
6. Logout and exit the application.

2

Figure 2. MonitorStatuses Sample Run

3.3 ReceiveFaxes

The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\ReceiveFaxes

(assuming you chose the default location for the installation).
The directory contains two files :ReceiveFaxes.cs and ReceiveFaxes.csproj.
The project is included in the solution provided.
This console application enables you to:
1. Login to the FAXCOM Queue.
2. Retrieve the Received Messages collection.
3. Display the count of received faxes in the mailbox.
4. Sort by Receive Time in reverse order (most recent first).
5. Display information for the first five faxes in the mailbox.
6. Logout and exit the application.

3

Figure 3. ReceiveFaxes Sample Run

3.4 EventMonitor

The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\EventMonitor

(assuming you chose the default location for the installation).
The directory contains two files: Program.cs and EventMonitor.csproj.
The project is included in the solution provided.
This console application enables you to:
1. Login to the FAXCOM Queue.
2. Set an event handler for a change in the list of received faxes.
3. Set an event handler for a change in the list of sent fax statuses.
4. Set an event handler for a new received fax.
5. Set an event handler for a new sent fax status.
6. Set an event handler for a change in the list of pending faxes.
7. Wait for and report events.

4

Figure 4. EventMonitor Sample Run

4. UI Application
4.1 ClientShell

The Client shell sample is Windows application using Windows Forms to provide
a Graphical User Interface to a fax client application. This application is not
complete and is solely intended as an illustration of how to use FAXCOMLib in a
Windows application.
The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\FAXCOMClient

(assuming you chose the default location for the installation).
This directory contains the FAXCOMClient.csproj that is included in the Samples
solution.
This sample shows how to:
1. Login using a dialog box.
2. Login using the LogOnCtl (described later in this document).
3. Display the hierarchy of folders and subfolders in the user’s mailbox.
4. Display the Activity log in a Windows ListView control.
5. Display the Pending Queue in a Windows ListView control.
6. Display the Sent and the Received messages collections in a Windows
ListView control.
7. Display all properties of the PendingMessage object.
8. Display all properties of the ReceivedMessage object.
9. Display all properties of the MessageStatus object .
10. Compose and send a fax message.

5

Figure 5. FAXCOMClient Sample Screen

5. .NET Controls
5.1 ActivityCtl

The ActivityCtl demonstrates how to retrieve and display the Activity log. The
Activity log contains information for all the sent and received faxes of the
currently-logged-in Queue
The Activity log control uses the IActivities collection and the IActivity interface,
and displays them in a ListView form.
The sample is located at :
\Program Files\Biscom\SDK\API for .NET\Samples\ActivityCtl

(assuming you chose the default location for the installation).
This directory contains the ActivityCtl.csproj that is included in the Samples
solution.

5.2 PendingCtl

The Pending Queue control demonstrates how to retrieve and display entries in
the Pending Queue, which is the list of faxes queued for transmission. Entries in
the queue can be deleted, released, held, and/or authorized.
The Pending Queue control uses the IPendingMessages collection interface and
the IPendingMessage interface. Entries are displayed in a ListView form.

6

The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\PendingCtl

(assuming you chose the default location for the installation).
This directory contains the PendingCtl.csproj that is included in the Samples
solution.

5.3 PendingGrid

This sample demonstrates how to display the Pending Queue entries in a grid
form.
The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\PendingGrid

(assuming you chose the default location for the installation).
This directory contains the PendingGrid.csproj that is included in the Samples
solution.

5.4 ReceiveCtl

The Receive Faxes control demonstrates how to access and retrieve received
fax information using the IReceivedMessages collection and the
IReceiveMessage interface.
The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\ReceiveCtl

(assuming you chose the default location for the installation).
This directory contains the ReceiveCtl.csproj that is included in the Samples
solution.

5.5 SentCtl

The Sent Faxes control demonstrates how to access and retrieve the sent fax
information using the IMessageStatusCollection interface and the
IMessageStatus interface.
The sample is located in:
\Program Files\Biscom\SDK\API for .NET\Samples\SentCtl

(assuming you chose the default location for the installation).
This directory contains the SentCtl.csproj that is included in the Samples
solution.

7
Source Exif Data: 
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : No
Tagged PDF                      : Yes
XMP Toolkit                     : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26
Modify Date                     : 2015:10:13 11:27:43-04:00
Create Date                     : 2015:10:13 11:26:09-04:00
Metadata Date                   : 2015:10:13 11:27:43-04:00
Creator Tool                    : Acrobat PDFMaker 10.1 for Word
Document ID                     : uuid:d8eeeae7-5d15-4305-a1db-d8f8750e2126
Instance ID                     : uuid:06f69d7a-ca85-44ef-9621-b328be3bf904
Subject                         : 7
Format                          : application/pdf
Title                           : FAXCOM
Creator                         : Tomas Keri
Producer                        : Adobe PDF Library 10.0
Source Modified                 : D:20151013152555
Company                         : .
Page Layout                     : OneColumn
Page Count                      : 10
Author                          : Tomas Keri
EXIF Metadata provided by EXIF.tools

Navigation menu