All requests to the plug-in have two required parameters. The first is operation, and the second is result-type. All operations except op-client-interface-version and op-client-version-info require the parameter printer-url. All requests support the optional parameter error-type.
With the exception of op-printer-send-test-page and op-printer-remove, the printer does not need to be installed to use the following operations:
|
Description: |
Determines a version associated with the plug-in’s HTML interface. Can also determine if a client upgrade needs to be invoked for any other client plug-in/HTML file compatibility issues. |
|
Required information: |
None |
|
Supported return types: |
URL, Cookie, Object |
|
Description: |
Determines if the indicated printer is installed on the workstation. |
|
Required information: |
Printer URL |
|
Supported return types: |
URL, Cookie, Object |
|
Description: |
Determines the version of the OpenText iPrint Client files running on the workstation. |
|
Required information: |
None |
|
Supported return types: |
Cookie, URL, Object |
|
Description: |
Deletes the indicated jobs. |
|
Required information |
Printer URL, job-list |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Gets job information for indicated jobs. The information returned depends on the printer’s capabilities. This information can include job name, ID, owner, size, bytes processed, hold until, priority, time created, time started printing, and time finished printing. |
|
Required information: |
Printer URL, job-list |
|
Supported return types: |
Message box, HTML, URL, Cookie |
|
Description: |
Puts a hold on the indicated jobs. A job that is printing might not be held. |
|
Required information: |
Printer URL, job-list |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
Supported parameter is indefinite.
|
Description: |
Removes the hold on the indicated jobs. |
|
Required information: |
Printer URL, job-list |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Gets additional information about the printer. The information returned depends on the printer’s capabilities. This information can include printer location, printer make and model, and supported document formats (PDLs). |
|
Required information: |
Printer URL |
|
Supported return types: |
Message box, HTML, URL, Cookie |
|
Description: |
Gets status information from the indicated printer. The information returned depends on the printer’s capabilities. Status can include printer state, printer state reasons, printer state message, printer accepting jobs, and printer job count. |
|
Required information: |
Printer URL |
|
Supported return types: |
Message box, HTML, URL, Cookie |
|
Description: |
Installs the indicated printer to this workstation. |
|
Required information: |
Printer URL |
|
Optional information: |
|
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Lists jobs for this printer. |
|
Required information: |
Printer URL |
|
Supported return types: |
Message box, HTML, URL, Cookie |
|
Description: |
Pauses the printer. If results are requested for this operation, the op-printer-get-status operation is executed to provide the new printer status. |
|
Required information: |
Printer URL |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Deletes all jobs for this printer. |
|
Required information: |
Printer URL |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Deletes the indicated printer from this workstation. |
|
Required information: |
Printer URL |
|
Supported return types: |
None, Message box, HTML |
|
Description: |
Resumes the printer. If results are requested for this operation, the op-printer-get-status operation is executed to provide the new printer status. |
|
Required information: |
Printer URL |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Sends a printer-ready file to this printer. |
|
Required information: |
Printer URL, file-path-name |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |
|
Description: |
Sends a test page to this printer. |
|
Required information: |
Printer URL |
|
Supported return types: |
None, Message box, HTML, URL, Cookie |