qz.configs.setDefaults docs for available values.
- *
- * @see qz.configs.setDefaults
- */
- this.reconfigure = function(newOpts) {
- for(var key in newOpts) {
- if (newOpts[key] !== undefined) {
- this._dirtyOpts[key] = true;
- }
- }
-
- _qz.tools.extend(this.config, newOpts);
- };
-
- /**
- * @returns {Object} The currently applied options on this config.
- */
- this.getOptions = function() {
- return _qz.compatible.config(this.config, this._dirtyOpts);
- };
-
- // init calls for new config object
- this.setPrinter(printer);
- this.reconfigure(opts);
- }
-
- /**
- * Shortcut method for calling qz.print with a particular config.
- * @param {Arrayqz.print docs for available values.
- * @param {boolean} [signature] Pre-signed signature of JSON string containing call, params, and timestamp.
- * @param {number} [signingTimestamp] Required with signature. Timestamp used with pre-signed content.
- *
- * @example
- * qz.print(myConfig, ...); // OR
- * myConfig.print(...);
- *
- * @see qz.print
- */
- Config.prototype.print = function(data, signature, signingTimestamp) {
- qz.print(this, data, signature, signingTimestamp);
- };
-
-
-///// PUBLIC METHODS /////
-
- /** @namespace qz */
- var qz = {
-
- /**
- * Calls related specifically to the web socket connection.
- * @namespace qz.websocket
- */
- websocket: {
- /**
- * Check connection status. Active connection is necessary for other calls to run.
- *
- * @returns {boolean} If there is an active connection with QZ Tray.
- *
- * @see connect
- *
- * @memberof qz.websocket
- */
- isActive: function() {
- return _qz.tools.isActive();
- },
-
- /**
- * Call to setup connection with QZ Tray on user's system.
- *
- * @param {Object} [options] Configuration options for the web socket connection.
- * @param {string|Arrayoptions.retries is 0.
- *
- * @returns {PromiseFunction({Event} event) calls.
- *
- * @memberof qz.websocket
- */
- setErrorCallbacks: function(calls) {
- _qz.websocket.errorCallbacks = calls;
- },
-
- /**
- * List of functions called for any connection closing event outside of an API call.
- * Also called when {@link websocket#disconnect} is called.
- *
- * @param {Function|ArrayFunction({Event} event) calls.
- *
- * @memberof qz.websocket
- */
- setClosedCallbacks: function(calls) {
- _qz.websocket.closedCallbacks = calls;
- },
-
- /**
- * @deprecated Since 2.1.0. Please use qz.networking.device() instead
- *
- * @param {string} [hostname] Hostname to try to connect to when determining network interfaces, defaults to "google.com"
- * @param {number} [port] Port to use with custom hostname, defaults to 443
- * @param {string} [signature] Pre-signed signature of hashed JSON string containing call='websocket.getNetworkInfo', params object, and timestamp.
- * @param {number} [signingTimestamp] Required with signature. Timestamp used with pre-signed content.
- *
- * @returns {Promisecall='printers.getDefault, params, and timestamp.
- * @param {number} [signingTimestamp] Required with signature. Timestamp used with pre-signed content.
- *
- * @returns {Promisecall='printers.find', params, and timestamp.
- * @param {number} [signingTimestamp] Required with signature. Timestamp used with pre-signed content.
- *
- * @returns {Promisequery is provided.
- * Otherwise an array of printer names found on the connected system.
- *
- * @memberof qz.printers
- */
- find: function(query, signature, signingTimestamp) {
- return _qz.websocket.dataPromise('printers.find', { query: query }, signature, signingTimestamp);
- },
-
- /**
- * Provides a list, with additional information, for each printer available to QZ.
- *
- * @returns {Promise[base64 | hex | plain*] (Windows only)
- *
- * @memberof qz.printers
- */
- startListening: function(printers, options) {
- if (!Array.isArray(printers)) {
- printers = [printers];
- }
- var params = {
- printerNames: printers
- };
- if (options && options.jobData == true) params.jobData = true;
- if (options && options.maxJobData) params.maxJobData = options.maxJobData;
- if (options && options.flavor) params.flavor = options.flavor;
- return _qz.websocket.dataPromise('printers.startListening', params);
- },
-
- /**
- * Clear the queue of a specified printer or printers. Does not delete retained jobs.
- *
- * @param {string|Object} [options] Name of printer to clear
- * @param {string} [options.printerName] Name of printer to clear
- * @param {number} [options.jobId] Cancel a job of a specific JobId instead of canceling all. Must include a printerName.
- *
- * @returns {Promise{string} printerName and {string} status for all types.
- * For RECEIVE types, {Array} output (in hexadecimal format).
- * For ERROR types, {string} exception.
- * For ACTION types, {string} actionType.
- *
- * @param {Function|ArrayFunction({Object} eventData) calls.
- * @since 2.1.0
- *
- * @memberof qz.printers
- */
- setPrinterCallbacks: function(calls) {
- _qz.printers.printerCallbacks = calls;
- }
- },
-
- /**
- * Calls related to setting up new printer configurations.
- * @namespace qz.configs
- */
- configs: {
- /**
- * Default options used by new configs if not overridden.
- * Setting a value to NULL will use the printer's default options.
- * Updating these will not update the options on any created config.
- *
- * @param {Object} options Default options used by printer configs if not overridden.
- *
- * @param {Object} [options.bounds=null] Bounding box rectangle.
- * @param {number} [options.bounds.x=0] Distance from left for bounding box starting corner
- * @param {number} [options.bounds.y=0] Distance from top for bounding box starting corner
- * @param {number} [options.bounds.width=0] Width of bounding box
- * @param {number} [options.bounds.height=0] Height of bounding box
- * @param {string} [options.colorType='color'] Valid values [color | grayscale | blackwhite | default]
- * @param {number} [options.copies=1] Number of copies to be printed.
- * @param {number|Array