/* * Copyright (c) 2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /** * @file * @kit BasicServicesKit */ import type { AsyncCallback, Callback } from './@ohos.base'; import type Context from './application/Context'; /** * System print * * @namespace print * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ declare namespace print { /** * PrintTask provide event callback. * @interface PrintTask * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintTask { /** * Register event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'block' } type - Indicates the print task has been blocked. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'block', callback: Callback): void; /** * Register event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'succeed' } type - Indicates the print task succeed. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'succeed', callback: Callback): void; /** * Register event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'fail' } type - Indicates the print task has completed with failure. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'fail', callback: Callback): void; /** * Register event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'cancel' } type - Indicates the print task has been cancelled. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ on(type: 'cancel', callback: Callback): void; /** * Unregister event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'block' } type - Indicates the print task has been blocked. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'block', callback?: Callback): void; /** * Unregister event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'succeed' } type - Indicates the print task succeed. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'succeed', callback?: Callback): void; /** * Unregister event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'fail' } type - Indicates the print task has completed with failure. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'fail', callback?: Callback): void; /** * Unregister event callback when the current print task is in process. * @permission ohos.permission.PRINT * @param { 'cancel' } type - Indicates the print task has been cancelled. * @param { Callback } callback - The callback function for print task change event * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ off(type: 'cancel', callback?: Callback): void; } /** * Third-party application implement this interface to render files to be printed. * @interface PrintDocumentAdapter * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintDocumentAdapter { /** * Implement this function to update the print file. * @permission ohos.permission.PRINT * @param { string } jobId - Indicates print job id. * @param { PrintAttributes } oldAttrs - Indicates old print attributes. * @param { PrintAttributes } newAttrs - Indicates new print attributes. * @param { int } fd - Indicates print file fd. * @param { function } writeResultCallback - Indicates this function should execute after the file is updated. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ onStartLayoutWrite(jobId: string, oldAttrs: PrintAttributes, newAttrs: PrintAttributes, fd: int, writeResultCallback: (jobId: string, writeResult: PrintFileCreationState) => void): void; /** * Implement this function to listen job status change. * @permission ohos.permission.PRINT * @param { string } jobId - Indicates print job id. * @param { PrintDocumentAdapterState } state - Indicates job changes to this state. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ onJobStateChanged(jobId: string, state: PrintDocumentAdapterState): void; } /** * Start new print task for App. * @permission ohos.permission.PRINT * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @param { AsyncCallback } callback - The callback function for print task. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function print(files: Array, callback: AsyncCallback): void; /** * Start new print task for App. * @permission ohos.permission.PRINT * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function print(files: Array): Promise; /** * Start new print task for App. * @permission ohos.permission.PRINT * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @param { Context } context - The ability context that initiates the call print request. * @param { AsyncCallback } callback - The callback function for print task. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function print(files: Array, context: Context, callback: AsyncCallback): void; /** * Start new print task for App. * @permission ohos.permission.PRINT * @param { Array } files - Indicates the filepath list to be printed. Only pdf and picture filetype are supported. * @param { Context } context - The ability context that initiates the call print request. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function print(files: Array, context: Context): Promise; /** * Start new print task for App And the App need update print file. * @permission ohos.permission.PRINT * @param { string } jobName - Indicates print file Name. * @param { PrintDocumentAdapter } printAdapter - Indicates functions implemented by the cpp. * @param { PrintAttributes } printAttributes - Indicates print attributes. * @param { Context } context - The ability context that initiates the call print request. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function print(jobName: string, printAdapter: PrintDocumentAdapter, printAttributes: PrintAttributes, context: Context): Promise; /** * defines print attributes. * @typedef PrintAttributes * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintAttributes { /** * Copies of document list. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ copyNumber?: int; /** * Range size to be printed. * @type { ?PrintPageRange } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ pageRange?: PrintPageRange; /** * Page size. * @type { ?(PrintPageSize | PrintPageType) } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ pageSize?: PrintPageSize | PrintPageType; /** * Print direction. * @type { ?PrintDirectionMode } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ directionMode?: PrintDirectionMode; /** * Color mode. * @type { ?PrintColorMode } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ colorMode?: PrintColorMode; /** * Duplex mode. * @type { ?PrintDuplexMode } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ duplexMode?: PrintDuplexMode; } /** * defines print page range. * @typedef PrintPageRange * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintPageRange { /** * Start page of sequence. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ startPage?: int; /** * End page of sequence. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ endPage?: int; /** * Discrete page of sequence. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ pages?: Array; } /** * defines print margin. * @typedef PrintMargin * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintMargin { /** * Top margin. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ top?: int; /** * Bottom margin. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ bottom?: int; /** * Left margin. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ left?: int; /** * Right margin. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ right?: int; } /** * defines print range. * @typedef PrinterRange * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterRange { /** * Start page of sequence. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ startPage?: int; /** * End page of sequence. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ endPage?: int; /** * Discrete page of sequence. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ pages?: Array; } /** * defines print preview attribute. * @typedef PreviewAttribute * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PreviewAttribute { /** * Preview page range. * @type { PrinterRange } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ previewRange: PrinterRange; /** * Preview file result. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ result?: int; } /** * defines print resolution. * @typedef PrintResolution * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintResolution { /** * Resolution id. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ id: string; /** * Horizontal DPI. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ horizontalDpi: int; /** * Vertical DPI. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ verticalDpi: int; } /** * defines print page size. * @typedef PrintPageSize * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintPageSize { /** * Page size id. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ id: string; /** * Page size name. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ name: string; /** * Unit: millimeter width. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ width: int; /** * Unit: millimeter height. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ height: int; } /** * defines print capability. * @typedef PrinterCapability * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterCapability { /** * Color mode. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ colorMode: int; /** * Duplex mode. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ duplexMode: int; /** * The page size list supported by the printer. * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ pageSize: Array; /** * The resolution list supported by the printer. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ resolution?: Array; /** * Min margin of printer. * @type { ?PrintMargin } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ minMargin?: PrintMargin; /** * JSON object string. * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ options?: Object; } /** * defines print info. * @typedef PrinterInfo * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterInfo { /** * Printer id. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ printerId: string; /** * Printer name. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ printerName: string; /** * Current printer state. * @type { PrinterState } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ printerState: PrinterState; /** * Resource id of printer icon. * @type { ?int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ printerIcon?: int; /** * Printer description. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ description?: string; /** * Printer capability. * @type { ?PrinterCapability } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ capability?: PrinterCapability; /** * JSON object string. * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ options?: Object; } /** * defines print job. * @typedef PrintJob * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrintJob { /** * Document fd list to be printed. * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ fdList: Array; /** * Job id. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ jobId: string; /** * Printer id to take charge of printing. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ printerId: string; /** * Current print job state. * @type { PrintJobState } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ jobState: PrintJobState; /** * Current print job sub state. * @type { PrintJobSubState } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ jobSubstate: PrintJobSubState; /** * Copies of document list. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ copyNumber: int; /** * Range size to be printed. * @type { PrinterRange } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ pageRange: PrinterRange; /** * Sequential print. * @type { boolean } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ isSequential: boolean; /** * The selected page size. * @type { PrintPageSize } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ pageSize: PrintPageSize; /** * Vertical printing. * @type { boolean } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ isLandscape: boolean; /** * Color mode. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ colorMode: int; /** * Duplex mode. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ duplexMode: int; /** * Current margin setting. * @type { ?PrintMargin } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ margin?: PrintMargin; /** * Preview setting. * @type { ?PreviewAttribute } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ preview?: PreviewAttribute; /** * JSON object string. * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ options?: Object; } /** * Enumeration of Print Direction Mode. * @enum { int } PrintDirectionMode * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintDirectionMode { /** * Automatically select direction. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DIRECTION_MODE_AUTO = 0, /** * Print portrait. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DIRECTION_MODE_PORTRAIT = 1, /** * Print landscape. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DIRECTION_MODE_LANDSCAPE = 2, } /** * Enumeration of Print Color Mode. * @enum { int } PrintColorMode * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintColorMode { /** * Print monochrome. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ COLOR_MODE_MONOCHROME = 0, /** * Color printing. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ COLOR_MODE_COLOR = 1, } /** * Enumeration of Print Duplex Mode. * @enum { int } PrintDuplexMode * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintDuplexMode { /** * Single side printing. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DUPLEX_MODE_NONE = 0, /** * Long-edge flip-up duplex printing. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DUPLEX_MODE_LONG_EDGE = 1, /** * Short-edge flip-up duplex printing. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ DUPLEX_MODE_SHORT_EDGE = 2, } /** * Enumeration of Print Page Type. * @enum { int } PrintPageType * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintPageType { /** * A3 page. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_ISO_A3 = 0, /** * A4 page. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_ISO_A4 = 1, /** * A5 page. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_ISO_A5 = 2, /** * B5 page. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_JIS_B5 = 3, /** * C5 page. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_ISO_C5 = 4, /** * DL Envelope. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_ISO_DL = 5, /** * Letter. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_LETTER = 6, /** * Legal. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_LEGAL = 7, /** * Photo 4x6. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_PHOTO_4X6 = 8, /** * Photo 5x7. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_PHOTO_5X7 = 9, /** * Envelope INT DL. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_INT_DL_ENVELOPE = 10, /** * Tabloid B. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PAGE_B_TABLOID = 11, } /** * Enumeration of Print Document Adapter State. * @enum { int } PrintDocumentAdapterState * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintDocumentAdapterState { /** * Preview failed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PREVIEW_DESTROY = 0, /** * Print state is succeed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_TASK_SUCCEED = 1, /** * Print state is fail. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_TASK_FAIL = 2, /** * Print state is cancel. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_TASK_CANCEL = 3, /** * Print state is block. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_TASK_BLOCK = 4, } /** * Enumeration of Print File Creation State. * @enum { int } PrintFileCreationState * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintFileCreationState { /** * Print file created success. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_FILE_CREATED = 0, /** * Print file created fail. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_FILE_CREATION_FAILED = 1, /** * Print file created success but unrendered. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_FILE_CREATED_UNRENDERED = 2, } /** * Enumeration of Printer State. * @enum { int } PrinterState * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrinterState { /** * New printers arrival. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_ADDED = 0, /** * Printer lost. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_REMOVED = 1, /** * Printer update. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_CAPABILITY_UPDATED = 2, /** * Printer has been connected. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_CONNECTED = 3, /** * Printer has been disconnected. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_DISCONNECTED = 4, /** * Printer is working. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_RUNNING = 5, } /** * Enumeration of Print Job State. * @enum { int } PrintJobState * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintJobState { /** * Initial state of print job. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_PREPARE = 0, /** * Deliver print job to the printer. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_QUEUED = 1, /** * Executing print job. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING = 2, /** * Print job has been blocked. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCKED = 3, /** * Print job completed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED = 4, } /** * Enumeration of Print Job Sub State. * @enum { int } PrintJobSubState * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintJobSubState { /** * Print job succeed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_SUCCESS = 0, /** * Print job fail. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_FAILED = 1, /** * Print job has been cancelled. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_CANCELLED = 2, /** * Print job has been corrupted. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_FILE_CORRUPTED = 3, /** * Print is offline. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OFFLINE = 4, /** * Print is occupied by other process. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_BUSY = 5, /** * Print job has been cancelled. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_CANCELLED = 6, /** * Print out of paper. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_PAPER = 7, /** * Print out of ink. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_INK = 8, /** * Print out of toner. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_TONER = 9, /** * Print paper jam. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_JAMMED = 10, /** * Print cover open. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_DOOR_OPEN = 11, /** * Print service request. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SERVICE_REQUEST = 12, /** * Print low on ink. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LOW_ON_INK = 13, /** * Print low on toner. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LOW_ON_TONER = 14, /** * Print really low on ink. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_REALLY_LOW_ON_INK = 15, /** * Print bad certification. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_BAD_CERTIFICATE = 16, /** * Print printer driver exception. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_DRIVER_EXCEPTION = 17, /** * Print an error occurred when printing the account. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_ACCOUNT_ERROR = 18, /** * Print the printing permission is abnormal. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_PRINT_PERMISSION_ERROR = 19, /** * Print color printing permission exception. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_PRINT_COLOR_PERMISSION_ERROR = 20, /** * Print the device is not connected to the network. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_NETWORK_ERROR = 21, /** * Print unable to connect to the server. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SERVER_CONNECTION_ERROR = 22, /** * Print large file exception. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LARGE_FILE_ERROR = 23, /** * Print file parsing exception. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_FILE_PARSING_ERROR = 24, /** * Print the file conversion is too slow. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SLOW_FILE_CONVERSION = 25, /** * Print uploading file. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING_UPLOADING_FILES = 26, /** * Print converting files. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING_CONVERTING_FILES = 27, /** * Print file uploading exception. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_FILE_UPLOADING_ERROR = 30, /** * Print driver file missing. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_DRIVER_MISSING = 34, /** * Print job interrupt. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_INTERRUPT = 35, /** * Print on an unavailable printer. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_PRINTER_UNAVAILABLE = 98, /** * Print unknown issue. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_UNKNOWN = 99, } /** * Enumeration of Print error Code. * @enum { int } PrintErrorCode * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintErrorCode { /** * No error. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_NONE = 0, /** * No permission. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_NO_PERMISSION = 201, /** * Invalid parameter. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_INVALID_PARAMETER = 401, /** * Generic failure of print. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_GENERIC_FAILURE = 13100001, /** * RPC failure. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_RPC_FAILURE = 13100002, /** * Failure of print service. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_SERVER_FAILURE = 13100003, /** * Invalid print extension. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_INVALID_EXTENSION = 13100004, /** * Invalid printer. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_INVALID_PRINTER = 13100005, /** * Invalid print job. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_INVALID_PRINT_JOB = 13100006, /** * File i/o error. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_FILE_IO = 13100007, /** * Number of files exceeding the upper limit. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ E_PRINT_TOO_MANY_FILES = 13100010, } /** * Enumeration of application event. * @enum { int } ApplicationEvent * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum ApplicationEvent { /** * Application created. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ APPLICATION_CREATED = 0, /** * Application closed for printing started. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ APPLICATION_CLOSED_FOR_STARTED = 1, /** * Application closed for printing canceled. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ APPLICATION_CLOSED_FOR_CANCELED = 2, } /** * defines print ExtensionInfo. * @typedef PrinterExtensionInfo * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterExtensionInfo { /** * Extension id of printer extension. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ extensionId: string; /** * Vendor id of extension. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ vendorId: string; /** * Vendor name. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ vendorName: string; /** * Vendor icon. * @type { int } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ vendorIcon: int; /** * Version of current printer extension. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ version: string; } /** * Get all printer extension installed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { AsyncCallback> } callback - The callback function for handling the extension list found. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function queryAllPrinterExtensionInfos(callback: AsyncCallback>): void; /** * Get all printer extension installed. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function queryAllPrinterExtensionInfos(): Promise>; /** * Load the specific printer extension and start to discover printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } extensionList - Indicates the list of printer extension. * empty list of extensionList Indicates to find printer with all installed extension. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Load the specific printer extension and start to discover printer. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @param { Array } extensionList - Indicates the list of printer extension. * empty list of extensionList Indicates to find printer with all installed extension. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function startDiscoverPrinter(extensionList: Array, callback: AsyncCallback): void; /** * Load the specific printer extension and start to discover printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } extensionList - Indicates the list of printer extension. * empty list of extensionList Indicates to find printer with all installed extension. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Load the specific printer extension and start to discover printer. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @param { Array } extensionList - Indicates the list of printer extension. * empty list of extensionList Indicates to find printer with all installed extension. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function startDiscoverPrinter(extensionList: Array): Promise; /** * Stop discovering the printer with specific printer extension. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Stop discovering the printer with specific printer extension. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function stopDiscoverPrinter(callback: AsyncCallback): void; /** * Stop discovering the printer with specific printer extension. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Stop discovering the printer with specific printer extension. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function stopDiscoverPrinter(): Promise; /** * Connect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Connect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @param { string } printerId - Indicates id of the printer. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function connectPrinter(printerId: string, callback: AsyncCallback): void; /** * Connect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 10 */ /** * Connect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since 20 * @arkts 1.1&1.2 */ function connectPrinter(printerId: string): Promise; /** * Disconnect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function disconnectPrinter(printerId: string, callback: AsyncCallback): void; /** * Disconnect the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function disconnectPrinter(printerId: string): Promise; /** * Query capability for the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @param { AsyncCallback } callback - The callback function for capability from printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrinterCapability(printerId: string, callback: AsyncCallback): void; /** * Query capability for the specific printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrinterCapability(printerId: string): Promise; /** * Start print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { PrintJob } jobInfo - Indicates the information of print job. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function startPrintJob(jobInfo: PrintJob, callback: AsyncCallback): void; /** * Start print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { PrintJob } jobInfo - Indicates the information of print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function startPrintJob(jobInfo: PrintJob): Promise; /** * Cancel the print job has been sent to printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates the specific print job. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function cancelPrintJob(jobId: string, callback: AsyncCallback): void; /** * Cancel the print job has been sent to printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates the specific print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function cancelPrintJob(jobId: string): Promise; /** * Restart the print job has been sent. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates the specific print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 20 * @arkts 1.1&1.2 */ function restartPrintJob(jobId: string): Promise; /** * Request preview of the print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { PrintJob } jobInfo - Indicates the information of print job. * @param { Callback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function requestPrintPreview(jobInfo: PrintJob, callback: Callback): void; /** * Request preview of the print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { PrintJob } jobInfo - Indicates the information of print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function requestPrintPreview(jobInfo: PrintJob): Promise; /** * Register event callback for the state change of printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'printerStateChange' } type - Indicates state change of printer. * @param { function } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'printerStateChange', callback: (state: PrinterState, info: PrinterInfo) => void): void; /** * Unregister event callback for the state change of printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'printerStateChange' } type - Indicates state change of printer. * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'printerStateChange', callback?: Callback): void; /** * Register event callback for the state change of print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'jobStateChange' } type - Indicates state change of printer. * @param { function } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'jobStateChange', callback: (state: PrintJobState, job: PrintJob) => void): void; /** * Unregister event callback for the state change of print job. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'jobStateChange' } type - Indicates state change of printer. * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'jobStateChange', callback?: Callback): void; /** * Register event callback for the information change of print extension. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'extInfoChange' } type - Indicates information change of print extension. * @param { function } callback - The callback function for information change of print extension. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'extInfoChange', callback: (extensionId: string, info: string) => void): void; /** * Unregister event callback for the information change of print extension. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { 'extInfoChange' } type - Indicates state change of printer. * @param { Callback } callback - The callback function for state change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'extInfoChange', callback?: Callback): void; /** * New printers have been found and notify Print SA. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printers - Indicates new arrived printer lists. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function addPrinters(printers: Array, callback: AsyncCallback): void; /** * New printers have been found and notify Print SA. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printers - Indicates new arrived printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function addPrinters(printers: Array): Promise; /** * Printers have been lost and notify Print SA. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printerIds - Indicates the lost printer lists. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function removePrinters(printerIds: Array, callback: AsyncCallback): void; /** * Printers have been lost and notify Print SA. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printerIds - Indicates the lost printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function removePrinters(printerIds: Array): Promise; /** * Update the information of the specific printers. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printers - Indicates to be updated printer lists. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinters(printers: Array, callback: AsyncCallback): void; /** * Update the information of the specific printers. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { Array } printers - Indicates to be updated printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinters(printers: Array): Promise; /** * Notify Print SA the state of printer has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @param { PrinterState } state - Indicates state of the printer. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinterState(printerId: string, state: PrinterState, callback: AsyncCallback): void; /** * Notify Print SA the state of printer has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @param { PrinterState } state - Indicates state of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinterState(printerId: string, state: PrinterState): Promise; /** * Notify Print SA the state of print job has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string} jobId - Indicates id of the print job. * @param { PrintJobState } state - Indicates new state of print job. * @param { PrintJobSubState } subState - Indicates sub state of print job. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState, callback: AsyncCallback): void; /** * Notify Print SA the state of print job has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string} jobId - Indicates id of the print job. * @param { PrintJobState } state - Indicates new state of print job. * @param { PrintJobSubState } subState - Indicates sub state of print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState): Promise; /** * Notify Print SA the state of print extension has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } info - Indicates changed information of print extension. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updateExtensionInfo(info: string, callback: AsyncCallback): void; /** * Notify Print SA the state of print extension has been changed. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } info - Indicates changed information of print extension. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @arkts 1.1&1.2 */ function updateExtensionInfo(info: string): Promise; /** * Get all the printJobs in the queue. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { AsyncCallback } callback - The callback function for handling the printJob list found. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @deprecated since 11 * @useinstead print#queryPrintJobList * @arkts 1.1&1.2 */ function queryAllPrintJobs(callback: AsyncCallback): void; /** * Get all the printJobs in the queue. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'10','1.2':'20'} * @deprecated since 11 * @useinstead print#queryPrintJobList * @arkts 1.1&1.2 */ function queryAllPrintJobs(): Promise; /** * Get all active printJobs in the queue. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise } Returns a list of all active print jobs. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since 20 * @arkts 1.1&1.2 */ function queryAllActivePrintJobs(): Promise; /** * Get all the printJobs in the queue. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { AsyncCallback> } callback - The callback function for handling the printJob list found. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrintJobList(callback: AsyncCallback>): void; /** * Get all the printJobs in the queue. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrintJobList(): Promise>; /** * Get printJob by jobId. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates id of the print job. * @param { AsyncCallback } callback - The callback function for get printJob by jobId. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrintJobById(jobId: string, callback: AsyncCallback): void; /** * Get printJob by jobId. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates id of the print job. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function queryPrintJobById(jobId: string): Promise; /** * Start getting print file. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates id of the print job. * @param { PrintAttributes } printAttributes - Indicates print attributes. * @param { int } fd - Indicates print file fd. * @param { Callback } onFileStateChanged - The callback function for update the file state. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function startGettingPrintFile(jobId: string, printAttributes: PrintAttributes, fd: int, onFileStateChanged: Callback): void; /** * Notify print service the information. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates id of the print job. * @param { 'spooler_closed_for_cancelled' | 'spooler_closed_for_started' } type - Indicates notify information. * @param { AsyncCallback } callback - The callback function for indcating the result of API execution. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started', callback: AsyncCallback): void; /** * Notify print service the information. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } jobId - Indicates id of the print job. * @param { 'spooler_closed_for_cancelled' | 'spooler_closed_for_started' } type - Indicates notify information. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'11','1.2':'20'} * @arkts 1.1&1.2 */ function notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started'): Promise; /** * Get all added printers. * @permission ohos.permission.MANAGE_PRINT_JOB or ohos.permission.PRINT * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function getAddedPrinters(): Promise>; /** * Get printer info by printer id. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ function getPrinterInfoById(printerId: string): Promise; /** * Notify print service of application event. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { ApplicationEvent } event - Indicates the event to be notified. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'12','1.2':'20'} * @arkts 1.1&1.2 */ function notifyPrintServiceEvent(event: ApplicationEvent): Promise; /** * New printers have been found and notify Print SA. * @permission ohos.permission.PRINT * @param { PrinterInformation } printerInformation - Indicates new arrived printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ function addPrinterToDiscovery(printerInformation: PrinterInformation): Promise; /** * Update the information of the specific printer. * @permission ohos.permission.PRINT * @param { PrinterInformation } printerInformation - Indicates to be updated printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinterInDiscovery(printerInformation: PrinterInformation): Promise; /** * Notify Print SA to remove printer. * @permission ohos.permission.PRINT * @param { string } printerId - Indicates the lost printer lists. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ function removePrinterFromDiscovery(printerId: string): Promise; /** * Get printerInformation by printer id. * @permission ohos.permission.PRINT * @param { string } printerId - Indicates id of the printer. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ function getPrinterInformationById(printerId: string): Promise; /** * defines printer information. * @typedef PrinterInformation * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterInformation { /** * Printer id. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ printerId: string; /** * Printer name. * @type { string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ printerName: string; /** * Current printer status. * @type { PrinterStatus } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ printerStatus: PrinterStatus; /** * Printer description. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ description?: string; /** * Printer capabilities. * @type { ?PrinterCapabilities } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ capability?: PrinterCapabilities; /** * Printer uri. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ uri?: string; /** * Printer make. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ printerMake?: string; /** * Printer preferences. * @type { ?PrinterPreferences } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ preferences?: PrinterPreferences; /** * Printer alias. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ alias?: string; /** * Detail information in json format. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ options?: string; } /** * defines printer capabilities. * @typedef PrinterCapabilities * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterCapabilities { /** * The page size list supported by the printer. * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedPageSizes: Array; /** * Array of supported color mode. * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedColorModes: Array; /** * Array of supported duplex mode. * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedDuplexModes: Array; /** * Array of supported print media types. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedMediaTypes?: Array; /** * Array of supported print quality. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedQualities?: Array; /** * Array of supported print orientation. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ supportedOrientations?: Array; /** * Advanced capability in json format. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ options?: string; } /** * Enumeration of Print Quality. * @enum { int } PrintQuality * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintQuality { /** * Draft quality mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ QUALITY_DRAFT = 3, /** * Normal quality mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ QUALITY_NORMAL = 4, /** * High quality mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ QUALITY_HIGH = 5, } /** * Enumeration of Print OrientationMode. * @enum { int } PrintOrientationMode * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrintOrientationMode { /** * Portrait mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ ORIENTATION_MODE_PORTRAIT = 0, /** * Landscape mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ ORIENTATION_MODE_LANDSCAPE= 1, /** * Reverse landscape mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ ORIENTATION_MODE_REVERSE_LANDSCAPE = 2, /** * Reverse portrait mode. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ ORIENTATION_MODE_REVERSE_PORTRAIT = 3, /** * Not specified. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ ORIENTATION_MODE_NONE = 4, } /** * Enumeration of Printer Status. * @enum { int } PrinterStatus * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ enum PrinterStatus { /** * Printer idle. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_IDLE = 0, /** * Printer busy. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_BUSY = 1, /** * Printer not available. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'14','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_UNAVAILABLE = 2, } /** * defines printer preferences. * @typedef PrinterPreferences * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ interface PrinterPreferences { /** * Default duplex mode. * @type { ?PrintDuplexMode } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ defaultDuplexMode?: PrintDuplexMode; /** * Default quality. * @type { ?PrintQuality } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ defaultPrintQuality?: PrintQuality; /** * Default media type. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ defaultMediaType?: string; /** * Default page size id. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ defaultPageSizeId?: string; /** * Default orientation mode. * @type { ?PrintOrientationMode } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ defaultOrientation?: PrintOrientationMode; /** * Default margins. * @type { ?boolean } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ borderless?: boolean; /** * Detailed printer preferences in json format. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ options?: string; } /** * Enumeration of Printer Change Events. * @enum { int } PrinterEvent * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ enum PrinterEvent { /** * Printer added. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_ADDED = 0, /** * Printer deleted. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_DELETED = 1, /** * Printer state changed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_STATE_CHANGED = 2, /** * Printer info changed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_INFO_CHANGED = 3, /** * Printer preference changed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_PREFERENCE_CHANGED = 4, /** * Last used printer changed. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ PRINTER_EVENT_LAST_USED_PRINTER_CHANGED = 5, } /** * Enumeration of default printer type. * @enum { int } DefaultPrinterType * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ enum DefaultPrinterType { /** * Default printer set by user. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ DEFAULT_PRINTER_TYPE_SET_BY_USER = 0, /** * The last used printer is used as the default printer. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ DEFAULT_PRINTER_TYPE_LAST_USED_PRINTER = 1, } /** * Update the information of the specific added printer. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { PrinterInformation } printerInformation - Indicates the printer to be updated. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function updatePrinterInformation(printerInformation: PrinterInformation): Promise; /** * Save the preferences set by the user. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates the printer to be updated. * @param { PrinterPreferences } printerPreferences - Indicates the printer preferences set by the user. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function setPrinterPreferences(printerId: string, printerPreferences: PrinterPreferences): Promise; /** * Discover all usb printers. * @permission ohos.permission.MANAGE_PRINT_JOB * @returns { Promise> } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function discoverUsbPrinters(): Promise>; /** * Save the default printer set by the user. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { string } printerId - Indicates the printer to be set as the default printer. * @param { DefaultPrinterType } type - Indicates the default printer type. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function setDefaultPrinter(printerId: string, type: DefaultPrinterType): Promise; /** * Notify print service of application event. * @permission ohos.permission.MANAGE_PRINT_JOB * @param { ApplicationEvent } event - Indicates the event to be notified. * @param { string } jobId - Indicates the job id. * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 202 - not system application * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function notifyPrintServiceEvent(event: ApplicationEvent, jobId: string): Promise; /** * Defines the callback type used in registering to listen for PrinterEvent. * The value of event indicates the information of PrinterEvent. * The value of printerInformation indicates the latest printer information. * * @typedef { function } PrinterChangeCallback * @param { PrinterEvent } event - the information of PrinterEvent * @param { PrinterInformation } printerInformation - the information of the latest printer * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ type PrinterChangeCallback = (event: PrinterEvent, printerInformation: PrinterInformation) => void; /** * Register event callback for the change of printer. * @permission ohos.permission.PRINT * @param { 'printerChange' } type - Indicates change of printer. * @param { PrinterChangeCallback } callback - The callback function for change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function on(type: 'printerChange', callback: PrinterChangeCallback): void; /** * Unregister event callback for the change of printer. * @permission ohos.permission.PRINT * @param { 'printerChange' } type - Indicates change of printer. * @param { PrinterChangeCallback } [callback] - The callback function for change of printer. * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @since arkts {'1.1':'18','1.2':'20'} * @arkts 1.1&1.2 */ function off(type: 'printerChange', callback?: PrinterChangeCallback): void; } export default print;