public interface FaxClientActions extends ProviderImplementation
Modifier and Type | Method and Description |
---|---|
void |
addFaxClientActionEventListener(FaxClientActionEventListener listener)
This function adds the fax client action event listener to the internal fax event listeners data structure.
|
void |
addFaxMonitorEventListener(FaxMonitorEventListener listener)
This function adds the fax monitor event listener to the internal fax event listeners data structure.
Fax jobs will be monitored only if there are active listeners registered. If the listeners are added after a fob job was submitted, that fax job would not be monitored. Not all SPIs support monitoring events, in which case this method will throw an exception. |
void |
cancelFaxJob(FaxJob faxJob)
This function will cancel an existing fax job.
|
FaxJob |
createFaxJob()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
FaxJobStatus |
getFaxJobStatus(FaxJob faxJob)
This function returns the fax job status.
Not all SPIs support extraction of the fax job status. In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status. |
void |
removeAllFaxClientActionEventListeners()
This function removes all fax client action event listeners from the internal fax event listeners data structure.
|
void |
removeAllFaxMonitorEventListeners()
This function removes all fax monitor event listeners from the internal fax event listeners data structure.
Not all SPIs support monitoring events. |
void |
removeFaxClientActionEventListener(FaxClientActionEventListener listener)
This function removes the fax client action event listener from the internal fax event listeners data structure.
|
void |
removeFaxMonitorEventListener(FaxMonitorEventListener listener)
This function removes the fax monitor event listener from the internal fax event listeners data structure.
Not all SPIs support monitoring events. |
void |
resumeFaxJob(FaxJob faxJob)
This function will resume an existing fax job.
|
void |
submitFaxJob(FaxJob faxJob)
This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object. |
void |
suspendFaxJob(FaxJob faxJob)
This function will suspend an existing fax job.
|
getProvider
FaxJob createFaxJob()
void submitFaxJob(FaxJob faxJob)
faxJob
- The fax job object containing the needed informationvoid suspendFaxJob(FaxJob faxJob)
faxJob
- The fax job object containing the needed informationvoid resumeFaxJob(FaxJob faxJob)
faxJob
- The fax job object containing the needed informationvoid cancelFaxJob(FaxJob faxJob)
faxJob
- The fax job object containing the needed informationFaxJobStatus getFaxJobStatus(FaxJob faxJob)
faxJob
- The fax job object containing the needed informationvoid addFaxClientActionEventListener(FaxClientActionEventListener listener)
listener
- The fax client action event listenervoid removeFaxClientActionEventListener(FaxClientActionEventListener listener)
listener
- The fax client action event listenervoid removeAllFaxClientActionEventListeners()
void addFaxMonitorEventListener(FaxMonitorEventListener listener)
listener
- The fax monitor event listenervoid removeFaxMonitorEventListener(FaxMonitorEventListener listener)
listener
- The fax monitor event listenervoid removeAllFaxMonitorEventListeners()
Copyright © 2009–2020 fax4j. All rights reserved.