@ohos.print (打印)(系统接口)

该模块为基本打印的操作API，提供调用基础打印功能的接口。

说明：
本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 当前界面仅包含本模块的系统接口，其他公开接口参见@ohos.print (打印)。

导入模块

import print from '@ohos.print';

PrintMargin

定义打印页边距的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrinterRange

定义打印范围的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PreviewAttribute

定义打印预览属性的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrintResolution

定义打印分辨率的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrinterCapability

定义打印能力的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrinterInfo

定义打印信息的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrintJob

定义打印任务的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

PrinterState

打印机状态的枚举。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

PrintJobState

打印任务状态的枚举。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

PrintJobSubState

打印任务子状态的枚举。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

PrintErrorCode

打印错误代码的枚举。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

PrinterExtensionInfo

定义打印扩展信息的接口。

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

queryAllPrinterExtensionInfos

queryAllPrinterExtensionInfos(callback: AsyncCallback<Array<PrinterExtensionInfo>>): void

查询所有已安装的打印机扩展服务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryAllPrinterExtensionInfos((err: BusinessError, extensionInfos: print.PrinterExtensionInfo[]) => {
    if (err) {
        console.log('queryAllPrinterExtensionInfos err ' + JSON.stringify(err));
    } else {
        console.log('queryAllPrinterExtensionInfos success ' + JSON.stringify(extensionInfos));
    }
})

queryAllPrinterExtensionInfos

queryAllPrinterExtensionInfos(): Promise<Array<PrinterExtensionInfo>>

查询所有已安装的打印机扩展服务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryAllPrinterExtensionInfos().then((extensionInfos: print.PrinterExtensionInfo[]) => {
    console.log('queryAllPrinterExtensionInfos success ' + JSON.stringify(extensionInfos));
    // ...
}).catch((error: BusinessError) => {
    console.log('failed to get AllPrinterExtension bacause ' + JSON.stringify(error));
})

startDiscoverPrinter

startDiscoverPrinter(extensionList: Array<string>, callback: AsyncCallback<void>): void

加载特定的打印机扩展并开始发现打印机，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let extensionList: string[] = [];
//extensionList内无信息表示发现所有扩展
print.startDiscoverPrinter(extensionList, (err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to start Discover Printer because : ' + JSON.stringify(err));
    } else {
        console.log('start Discover Printer success data : ' + JSON.stringify(data));
    }
})

startDiscoverPrinter

startDiscoverPrinter(extensionList: Array<string>): Promise<void>

加载特定的打印机扩展并开始发现打印机，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let extensionList: string[] = [];
//extensionList内无信息表示发现所有扩展
print.startDiscoverPrinter(extensionList).then((data : void) => {
    console.log('start Discovery success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to start Discovery because : ' + JSON.stringify(error));
})

stopDiscoverPrinter

stopDiscoverPrinter(callback: AsyncCallback<void>): void

停止发现具有特定打印机扩展的打印机，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.stopDiscoverPrinter((err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to stop Discover Printer because : ' + JSON.stringify(err));
    } else {
        console.log('stop Discover Printer success data : ' + JSON.stringify(data));
    }
})

stopDiscoverPrinter

stopDiscoverPrinter(): Promise<void>

停止发现具有特定打印机扩展的打印机，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.stopDiscoverPrinter().then((data : void) => {
    console.log('stop Discovery success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to stop Discovery because : ' + JSON.stringify(error));
})

connectPrinter

connectPrinter(printerId: string, callback: AsyncCallback<void>): void

连接特定打印机，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.connectPrinter(printerId, (err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to connect Printer because : ' + JSON.stringify(err));
    } else {
        console.log('start connect Printer success data : ' + JSON.stringify(data));
    }
})

connectPrinter

connectPrinter(printerId: string): Promise<void>

连接特定打印机，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.connectPrinter(printerId).then((data : void) => {
    console.log('start connect Printer success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to connect Printer because : ' + JSON.stringify(error));
})

disconnectPrinter

disconnectPrinter(printerId: string, callback: AsyncCallback<void>): void

断开特定打印机的连接，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.disconnectPrinter(printerId, (err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to disconnect Printer because : ' + JSON.stringify(err));
    } else {
        console.log('start disconnect Printer success data : ' + JSON.stringify(data));
    }
})

disconnectPrinter

disconnectPrinter(printerId: string): Promise<void>

断开特定打印机的连接，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.disconnectPrinter(printerId).then((data : void) => {
    console.log('start disconnect Printer success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to disconnect Printer because : ' + JSON.stringify(error));
})

queryPrinterCapability

queryPrinterCapability(printerId: string, callback: AsyncCallback<void>): void

查询打印机能力，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.queryPrinterCapability(printerId, (err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to query Printer Capability because : ' + JSON.stringify(err));
    } else {
        console.log('start query Printer Capability success data : ' + JSON.stringify(data));
    }
})

queryPrinterCapability

queryPrinterCapability(printerId: string): Promise<void>

查询打印机能力，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId: string = 'printerId_32';
print.queryPrinterCapability(printerId).then((data : void) => {
    console.log('start query Printer success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to query Printer Capability because : ' + JSON.stringify(error));
})

startPrintJob

startPrintJob(jobInfo: PrintJob, callback: AsyncCallback<void>): void

开始打印任务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobInfo : print.PrintJob = {
    fdList : [0,1],
    jobId : 'jobId_12',
    printerId : 'printerId_32',
    jobState : 3,
    jobSubstate : print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS,
    copyNumber : 1,
    pageRange : {},
    isSequential : false,
    pageSize : {id : '', name : '', width : 10, height : 20},
    isLandscape : false,
    colorMode : 6,
    duplexMode : 6,
    margin : undefined,
    preview : undefined,
    options : undefined
};
print.startPrintJob(jobInfo, (err: BusinessError, data : void) => {
    if (err) {
        console.log('failed to start Print Job because : ' + JSON.stringify(err));
    } else {
        console.log('start Print Job success data : ' + JSON.stringify(data));
    }
})

startPrintJob

startPrintJob(jobInfo: PrintJob): Promise<void>

开始打印任务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobInfo : print.PrintJob = {
    fdList : [0,1],
    jobId : 'jobId_12',
    printerId : 'printerId_32',
    jobState : 3,
    jobSubstate : print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS,
    copyNumber : 1,
    pageRange : {},
    isSequential : false,
    pageSize : {id : '', name : '', width : 10, height : 20},
    isLandscape : false,
    colorMode : 6,
    duplexMode : 6,
    margin : undefined,
    preview : undefined,
    options : undefined
};
print.startPrintJob(jobInfo).then((data : void) => {
    console.log('start Print success data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('failed to start Print because : ' + JSON.stringify(error));
})

cancelPrintJob

cancelPrintJob(jobId: string, callback: AsyncCallback<void>): void

取消已发送到打印机的打印任务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '121212';
print.cancelPrintJob(jobId, (err: BusinessError, data : void) => {
    if (err) {
        console.log('cancelPrintJob failed, because : ' + JSON.stringify(err));
    } else {
        console.log('cancelPrintJob success, data: ' + JSON.stringify(data));
    }
})

cancelPrintJob

cancelPrintJob(jobId: string): Promise<void>

取消已发送到打印机的打印任务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '121212';
print.cancelPrintJob(jobId).then((data : void) => {
    console.log('cancelPrintJob success, data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('cancelPrintJob failed, because : ' + JSON.stringify(error));
})

requestPrintPreview

requestPrintPreview(jobInfo: PrintJob, callback: Callback<number>): void

请求预览打印数据，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

let jobInfo : print.PrintJob = {
    fdList : [0,1],
    jobId : 'jobId_12',
    printerId : 'printerId_32',
    jobState : 3,
    jobSubstate : print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS,
    copyNumber : 1,
    pageRange : {},
    isSequential : false,
    pageSize : {id : '', name : '', width : 10, height : 20},
    isLandscape : false,
    colorMode : 6,
    duplexMode : 6,
    margin : undefined,
    preview : undefined,
    options : undefined
};
print.requestPrintPreview(jobInfo, (num : number) => {
    console.log('requestPrintPreview success, num : ' + JSON.stringify(num));

})

requestPrintPreview

requestPrintPreview(jobInfo: PrintJob): Promise<number>

请求预览打印数据，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobInfo : print.PrintJob = {
    fdList : [0,1],
    jobId : 'jobId_12',
    printerId : 'printerId_32',
    jobState : 3,
    jobSubstate : print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS,
    copyNumber : 1,
    pageRange : {},
    isSequential : false,
    pageSize : {id : '', name : '', width : 10, height : 20},
    isLandscape : false,
    colorMode : 6,
    duplexMode : 6,
    margin : undefined,
    preview : undefined,
    options : undefined
};
print.requestPrintPreview(jobInfo).then((num: number) => {
    console.log('requestPrintPreview success, num : ' + JSON.stringify(num));
}).catch((error: BusinessError) => {
    console.log('requestPrintPreview failed, because : ' + JSON.stringify(error));
})

on

on(type: 'printerStateChange', callback: (state: PrinterState, info: PrinterInfo) => void): void

注册打印机状态变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.on('printerStateChange', (state: print.PrinterState, info: print.PrinterInfo) => {
    if (state === null || info === null) {
        console.log('printer state changed state is null or info is null');
        return;
    } else {
        console.log('on printer state changed, state : ' + JSON.stringify(state));
        console.log('on printer state changed, info : ' + JSON.stringify(info));
    }
})

off

off(type: 'printerStateChange', callback?: Callback<boolean>): void

取消注册打印机状态变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.off('printerStateChange', (data: boolean) => {
    console.log('off printerStateChange data : ' + JSON.stringify(data));
})

on

on(type: 'jobStateChange', callback: (state: PrintJobState, job: PrintJob) => void): void

注册打印任务状态变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.on('jobStateChange', (state: print.PrintJobState, job: print.PrintJob) => {
    console.log('onJobStateChange, state : ' + JSON.stringify(state) + ', job : ' + JSON.stringify(job));
})

off

off(type: 'jobStateChange', callback?: Callback<boolean>): void

取消注册打印任务状态变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.off('jobStateChange', (data: boolean) => {
    console.log('offJobStateChanged data : ' + JSON.stringify(data));
})

on

on(type: 'extInfoChange', callback: (extensionId: string, info: string) => void): void

注册打印扩展信息变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.on('extInfoChange', (extensionId: string, info: string) => {
    console.log('onExtInfoChange, entensionId : ' + JSON.stringify(extensionId) + ', info : ' + JSON.stringify(info));
})

off

off(type: 'extInfoChange', callback?: Callback<boolean>): void

取消注册打印扩展信息变化事件回调，使用callback回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';

print.off('extInfoChange', (data: boolean) => {
    console.log('offExtInfoChange data : ' + JSON.stringify(data));
})

addPrinters

addPrinters(printers: Array<PrinterInfo>, callback: AsyncCallback<void>): void

添加打印机，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerInfo : print.PrinterInfo = {
    printerId : '3232',
    printerName : 'hhhhh',
    printerState : 0,
    printerIcon : 12,
    description : 'str',
    capability : undefined,
    options : 'opt'
};
print.addPrinters([printerInfo], (err: BusinessError, data : void) => {
    if (err) {
        console.log('addPrinters failed, because : ' + JSON.stringify(err));
    } else {
        console.log('addPrinters success, data : ' + JSON.stringify(data));
    }
})

addPrinters

addPrinters(printers: Array<PrinterInfo>): Promise<void>

添加打印机，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerInfo : print.PrinterInfo = {
    printerId : '3232',
    printerName : 'hhhhh',
    printerState : 0,
    printerIcon : 12,
    description : 'str',
    capability : undefined,
    options : 'opt'
};
print.addPrinters([printerInfo]).then((data : void) => {
    console.log('add printers data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('add printers error : ' + JSON.stringify(error));
})

removePrinters

removePrinters(printerIds: Array<string>, callback: AsyncCallback<void>): void

移除打印机，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId : string = '1212';
print.removePrinters([printerId], (err: BusinessError, data : void) => {
    if (err) {
        console.log('removePrinters failed, because : ' + JSON.stringify(err));
    } else {
        console.log('removePrinters success, data : ' + JSON.stringify(data));
    }
})

removePrinters

removePrinters(printerIds: Array<string>): Promise<void>

移除打印机，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId : string = '1212';
print.removePrinters([printerId]).then((data : void) => {
    console.log('remove printers data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('remove printers error : ' + JSON.stringify(error));
})

updatePrinters

updatePrinters(printers: Array<PrinterInfo>, callback: AsyncCallback<void>): void

更新特定打印机的信息，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerInfo : print.PrinterInfo = {
    printerId : '3232',
    printerName : 'hhhhh',
    printerState : 0,
    printerIcon : 12,
    description : 'str',
    capability : undefined,
    options : 'opt'
};
print.updatePrinters([printerInfo], (err: BusinessError, data : void) => {
    if (err) {
        console.log('updataPrinters failed, because : ' + JSON.stringify(err));
    } else {
        console.log('updataPrinters success, data : ' + JSON.stringify(data));
    }
})

updatePrinters

updatePrinters(printers: Array<PrinterInfo>): Promise<void>

更新特定打印机的信息，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerInfo : print.PrinterInfo = {
    printerId : '3232',
    printerName : 'hhhhh',
    printerState : 0,
    printerIcon : 12,
    description : 'str',
    capability : undefined,
    options : 'opt'
};
print.updatePrinters([printerInfo]).then((data : void) => {
    console.log('update printers data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('update printers error : ' + JSON.stringify(error));
})

updatePrinterState

updatePrinterState(printerId: string, state: PrinterState, callback: AsyncCallback<void>): void

更新打印机状态，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId : string = '1212';
let state : print.PrinterState = print.PrinterState.PRINTER_CONNECTED;
print.updatePrinterState(printerId, state, (err: BusinessError, data : void) => {
    if (err) {
        console.log('updataPrinterState failed, because : ' + JSON.stringify(err));
    } else {
        console.log('updataPrinterState success, data : ' + JSON.stringify(data));
    }
})

updatePrinterState

updatePrinterState(printerId: string, state: PrinterState): Promise<void>

更新打印机状态，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let printerId : string = '1212';
let state : print.PrinterState = print.PrinterState.PRINTER_CONNECTED;
print.updatePrinterState(printerId, state).then((data : void) => {
    console.log('update printer state data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('update printer state error : ' + JSON.stringify(error));
})

updatePrintJobState

updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState, callback: AsyncCallback<void>): void

更新打印任务状态，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '3434';
let state : print.PrintJobState = print.PrintJobState.PRINT_JOB_PREPARE;
let subState : print.PrintJobSubState = print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS;
print.updatePrintJobState(jobId, state, subState, (err: BusinessError, data : void) => {
    if (err) {
        console.log('updataPrintJobState failed, because : ' + JSON.stringify(err));
    } else {
        console.log('updatePrintJobState success, data : ' + JSON.stringify(data));
    }
})

updatePrintJobState

updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState): Promise<void>

更新打印任务状态，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '3434';
let state : print.PrintJobState = print.PrintJobState.PRINT_JOB_PREPARE;
let subState : print.PrintJobSubState = print.PrintJobSubState.PRINT_JOB_COMPLETED_SUCCESS;
print.updatePrintJobState(jobId, state, subState).then((data : void) => {
    console.log('update print job state data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('update print job state error : ' + JSON.stringify(error));
})

updateExtensionInfo

updateExtensionInfo(info: string, callback: AsyncCallback<void>): void

更新打印扩展状态，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let info : string = 'WIFI_INACTIVE';
print.updateExtensionInfo(info, (err: BusinessError, data : void) => {
    if (err) {
        console.log('updateExtensionInfo failed, because : ' + JSON.stringify(err));
    } else {
        console.log('updateExtensionInfo success, data : ' + JSON.stringify(data));
    }
})

updateExtensionInfo

updateExtensionInfo(info: string): Promise<void>

更新打印扩展状态，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let info : string = 'WIFI_INACTIVE';
print.updateExtensionInfo(info).then((data : void) => {
    console.log('update print job state data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('update print job state error : ' + JSON.stringify(error));
})

queryAllPrintJobs^(deprecated)

从API version 10开始支持，从API version 11开始废弃。 建议使用queryPrintJobList替代。

queryAllPrintJobs(callback: AsyncCallback<void>): void

查询所有打印任务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryAllPrintJobs((err: BusinessError, data : void) => {
    if (err) {
        console.log('queryAllPrintJobs failed, because : ' + JSON.stringify(err));
    } else {
        console.log('queryAllPrintJobs success, data : ' + JSON.stringify(data));
    }
})

queryAllPrintJobs^(deprecated)

从API version 10开始支持，从API version 11开始废弃。 建议使用queryPrintJobList替代。

queryAllPrintJobs(): Promise<void>

查询所有打印任务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryAllPrintJobs().then((data : void) => {
    console.log('queryAllPrintJobs success, data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('queryAllPrintJobs failed, error : ' + JSON.stringify(error));
})

queryPrintJobList¹¹⁺

queryPrintJobList(callback: AsyncCallback<Array<PrintJob>>): void

查询所有打印任务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryPrintJobList((err: BusinessError, printJobs : print.PrintJob[]) => {
    if (err) {
        console.log('queryPrintJobList failed, because : ' + JSON.stringify(err));
    } else {
        console.log('queryPrintJobList success, data : ' + JSON.stringify(printJobs));
    }
})

queryPrintJobList¹¹⁺

queryPrintJobList(): Promise<Array<PrintJob>>

查询所有打印任务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

print.queryPrintJobList().then((printJobs : print.PrintJob[]) => {
    console.log('queryPrintJobList success, data : ' + JSON.stringify(printJobs));
}).catch((error: BusinessError) => {
    console.log('queryPrintJobList failed, error : ' + JSON.stringify(error));
})

queryPrintJobById¹¹⁺

queryPrintJobById(jobId: string, callback: AsyncCallback<PrintJob>): void

按打印任务ID查询打印任务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '1';
print.queryPrintJobById(jobId, (err: BusinessError, printJob : print.PrintJob) => {
    if (err) {
        console.log('queryPrintJobById failed, because : ' + JSON.stringify(err));
    } else {
        console.log('queryPrintJobById success, data : ' + JSON.stringify(printJob));
    }
})

queryPrintJobById¹¹⁺

queryPrintJobById(jobId: string): Promise<PrintJob>

按打印任务ID查询打印任务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '1';
print.queryPrintJobById(jobId).then((printJob : print.PrintJob) => {
    console.log('queryPrintJobById data : ' + JSON.stringify(printJob));
}).catch((error: BusinessError) => {
    console.log('queryPrintJobById error : ' + JSON.stringify(error));
})

startGettingPrintFile¹¹⁺

startGettingPrintFile(jobId: string, printAttributes: PrintAttributes, fd: number, onFileStateChanged: Callback<PrintFileCreationState>): void

开始获取打印文件，使用Callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string= '1';
class MyPrintAttributes implements print.PrintAttributes {
    copyNumber?: number;
    pageRange?: print.PrintPageRange;
    pageSize?: print.PrintPageSize | print.PrintPageType;
    directionMode?: print.PrintDirectionMode;
    colorMode?: print.PrintColorMode;
    duplexMode?: print.PrintDuplexMode;
}

class MyPrintPageRange implements print.PrintPageRange {
    startPage?: number;
    endPage?: number;
    pages?: Array<number>;
}

class MyPrintPageSize implements print.PrintPageSize {
    id: string = '0';
    name: string = '0';
    width: number = 210;
    height: number = 297;
}

let printAttributes = new MyPrintAttributes();
printAttributes.copyNumber = 2;
printAttributes.pageRange = new MyPrintPageRange();
printAttributes.pageRange.startPage = 0;
printAttributes.pageRange.endPage = 5;
printAttributes.pageRange.pages = [1, 3];
printAttributes.pageSize = print.PrintPageType.PAGE_ISO_A3;
printAttributes.directionMode = print.PrintDirectionMode.DIRECTION_MODE_AUTO;
printAttributes.colorMode = print.PrintColorMode.COLOR_MODE_MONOCHROME;
printAttributes.duplexMode = print.PrintDuplexMode.DUPLEX_MODE_NONE;

let fd : number = 1;
print.startGettingPrintFile(jobId, printAttributes, fd, (state: print.PrintFileCreationState) => {
    console.log('onFileStateChanged success, data : ' + JSON.stringify(state));
})

notifyPrintService¹¹⁺

notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started', callback: AsyncCallback<void>): void

将spooler关闭信息通知打印服务，使用callback异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '1';
print.notifyPrintService(jobId, 'spooler_closed_for_started', (err: BusinessError, data : void) => {
    if (err) {
        console.log('notifyPrintService failed, because : ' + JSON.stringify(err));
    } else {
        console.log('notifyPrintService success, data : ' + JSON.stringify(data));
    }
})

notifyPrintService¹¹⁺

notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started'): Promise<void>

将spooler关闭信息通知打印服务，使用Promise异步回调。

需要权限： ohos.permission.MANAGE_PRINT_JOB

系统接口： 此接口为系统接口。

系统能力： SystemCapability.Print.PrintFramework

参数：

返回值：

示例：

import print from '@ohos.print';
import { BusinessError } from '@ohos.base';

let jobId : string = '1';
print.notifyPrintService(jobId, 'spooler_closed_for_started').then((data : void) => {
    console.log('notifyPrintService data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('notifyPrintService error : ' + JSON.stringify(error));
})