If you have recently purchased the RightFax COM API ModuleTM, or are thinking about doing so, there are several things you should know before you get started. If you intend on using the module to further customize your RightFax server, there are many ways in which a developer will be able to use the module’s library of objects, properties, and methods to code custom applications that run any number of tasks. The most important thing to note is that API development requires knowledge of and practice using one or more coding languages. If you need help setting up your RightFax COM API Module, you can refer to this blog post here.
Note: The RightFax COM API Module is not included with RightFax 16.6, but can be added as a separate install.
The Basics of the RightFax COM API Module
In the most basic of terms, the RightFax COM API Module is an additional interface that is used with the standard Component Object Model (COM) services that are included in all 32-bit Windows operating systems. The COM API helps users by providing tools that allow them to customize RightFax products (like fax servers!). There are also a variety of pre-defined objects stored in the RightFax COM API library.
About Objects, Properties and Methods
The library within the COM API contains three things:
- Objects: discrete entities within the system that can be changed. Some examples are users, documents and attachments. If there are multiple objects, this is known as a collection.
- Properties: within each object are descriptions that are used to identify the object, set permissions or show some type of status. The object “User” will have properties like “UserID” and “Password”.
- Methods: objects will also contain methods, which are actions that the object can perform. Some examples of this are sending faxes and logging into a specific server.
The first object that must be created is the “FaxServer” object, which will be used to create and contain all the other objects in the COM API. No other objects can be created without first creating the FaxServer object because all other objects in the object model will be contained within it. This is known as object hierarchy. The FaxServer object will also be used in the Module’s “Event Handler”, which is used to define actions that take place based on certain events (e.g. receiving a fax).
Other Important Tips for Using the COM API
- COM API uses descriptive interface definition language (IDL). Documentation exists that describes every function and what it is supposed to do.
- Knowledge of the coding language Visual Basic is a must for using the module.
- Some object properties use enumerated data types, which are specific, pre-determined values that generally consist of a text name and number that represents the text.
What You Can Accomplish with the COM API
The RightFax COM API Module can help you automate some actions and text fields within RightFax, including:
- Cover sheet information
- Billing information codes
- Showing a list of users
- List faxes for a user
- So much more