刘刘昊苏修改打印扫描文档格式; Signed-off-by:liuhaosu@huawei.com

15ab490c创建于 2025年2月6日历史提交

@ohos.print (打印)

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

说明：
本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { print } from '@kit.BasicServicesKit';

PrintTask

打印任务完成后的事件监听回调接口类。

on

on(type: 'block', callback: Callback<void>): void

注册打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	注册监听，监听字段：block，表示打印阻塞
callback	Callback<void>	是	打印完成后处于响应状态的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.on('block', () => {
        console.log('print state is block');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

on

on(type: 'succeed', callback: Callback<void>): void

注册打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	注册监听，监听字段：succeed，表示打印成功
callback	Callback<void>	是	打印完成后处于响应状态的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.on('succeed', () => {
        console.log('print state is succeed');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

on

on(type: 'fail', callback: Callback<void>): void

注册打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	注册监听，监听字段：fail，表示打印失败
callback	Callback<void>	是	打印完成后处于响应状态的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.on('fail', () => {
        console.log('print state is fail');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

on

on(type: 'cancel', callback: Callback<void>): void

注册打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	注册监听，监听字段：cancel，表示打印取消
callback	Callback<void>	是	打印完成后处于响应状态的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.on('cancel', () => {
        console.log('print state is cancel');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

off

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

取消打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	取消监听，监听字段：block，表示打印阻塞
callback	Callback<void>	否	取消相应状态监听成功后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.off('block', () => {
        console.log('unregister state block');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

off

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

取消打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	取消监听，监听字段：succeed，表示打印成功
callback	Callback<void>	否	取消相应状态监听成功后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.off('succeed', () => {
        console.log('unregister state succeed');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

off

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

取消打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	取消监听，监听字段：fail，表示打印失败
callback	Callback<void>	否	取消相应状态监听成功后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.off('fail', () => {
        console.log('unregister state fail');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

off

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

取消打印完成后的监听，使用callback回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
type	string	是	取消监听，监听字段：cancel，表示打印取消
callback	Callback<void>	否	取消相应状态监听成功后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let file = ['file://data/print/a.png', 'file://data/print/b.png'];
print.print(file).then((printTask: print.PrintTask) => {
    printTask.off('cancel', () => {
        console.log('unregister state cancel');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

PrintDocumentAdapter¹¹⁺

第三方应用程序实现此接口来渲染要打印的文件。

onStartLayoutWrite

onStartLayoutWrite(jobId: string, oldAttrs: PrintAttributes, newAttrs: PrintAttributes, fd: number, writeResultCallback: (jobId: string, writeResult: PrintFileCreationState) => void): void

打印服务会通过本接口将一个空的pdf文件的文件描述符传给三方应用，由三方应用使用新的打印参数更新待打印文件，更新文件完成后通过本接口的回调方法writeResultCallback通知打印服务。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
jobId	string	是	表示打印任务ID
oldAttrs	PrintAttributes	是	表示旧打印参数
newAttrs	PrintAttributes	是	表示新打印参数
fd	number	是	表示打印文件传给接口调用方的pdf文件的文件描述符
writeResultCallback	(jobId: string, writeResult: PrintFileCreationState)	是	表示三方应用使用新的打印参数更新待打印文件完成后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

class MyPrintDocumentAdapter implements print.PrintDocumentAdapter {
    onStartLayoutWrite(jobId: string, oldAttrs: print.PrintAttributes, newAttrs: print.PrintAttributes, fd: number,
        writeResultCallback: (jobId: string, writeResult: print.PrintFileCreationState) => void) {
        writeResultCallback(jobId, print.PrintFileCreationState.PRINT_FILE_CREATED);
    };
    onJobStateChanged(jobId: string, state: print.PrintDocumentAdapterState) {
        if (state == print.PrintDocumentAdapterState.PREVIEW_DESTROY) {
            console.log('PREVIEW_DESTROY');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_SUCCEED) {
            console.log('PRINT_TASK_SUCCEED');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_FAIL) {
            console.log('PRINT_TASK_FAIL');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_CANCEL) {
            console.log('PRINT_TASK_CANCEL');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_BLOCK) {
            console.log('PRINT_TASK_BLOCK');
        }
    }
}

onJobStateChanged

onJobStateChanged(jobId: string, state: PrintDocumentAdapterState): void

实现这个接口来监听打印任务状态的改变。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
jobId	string	是	表示打印任务ID
state	PrintDocumentAdapterState	是	表示打印任务更改为该状态

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

class MyPrintDocumentAdapter implements print.PrintDocumentAdapter {
    onStartLayoutWrite(jobId: string, oldAttrs: print.PrintAttributes, newAttrs: print.PrintAttributes, fd: number,
        writeResultCallback: (jobId: string, writeResult: print.PrintFileCreationState) => void) {
        writeResultCallback(jobId, print.PrintFileCreationState.PRINT_FILE_CREATED);
    };
    onJobStateChanged(jobId: string, state: print.PrintDocumentAdapterState) {
        if (state == print.PrintDocumentAdapterState.PREVIEW_DESTROY) {
            console.log('PREVIEW_DESTROY');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_SUCCEED) {
            console.log('PRINT_TASK_SUCCEED');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_FAIL) {
            console.log('PRINT_TASK_FAIL');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_CANCEL) {
            console.log('PRINT_TASK_CANCEL');
        } else if (state == print.PrintDocumentAdapterState.PRINT_TASK_BLOCK) {
            console.log('PRINT_TASK_BLOCK');
        }
    }
}

print

print(files: Array<string>, callback: AsyncCallback<PrintTask>): void

打印接口，传入文件进行打印，使用callback异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
files	Array<string>	是	待打印文件列表，支持图片（.jpg .png .gif .bmp .webp）和pdf。系统应用传入uri时，需先调用uriPermissionManager.grantUriPermission()接口给打印应用授权，此接口为系统接口。三方应用建议使用print。
callback	AsyncCallback<PrintTask>	是	异步获取打印完成之后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

//传入文件的uri
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
//或者传入fd
//let files = ['fd://1', 'fd://2'];
print.print(files, (err: BusinessError, printTask: print.PrintTask) => {
    if (err) {
        console.log('print err ' + JSON.stringify(err));
    } else {
        printTask.on('succeed', () => {
            console.log('print state is succeed');
        })
        // ...
    }
})

print

print(files: Array<string>): Promise<PrintTask>

打印接口，传入文件进行打印，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
files	Array<string>	是	待打印文件列表，支持图片（.jpg .png .gif .bmp .webp）和pdf。系统应用传入uri时，需先调用uriPermissionManager.grantUriPermission()接口给打印应用授权，此接口为系统接口。三方应用建议使用print。

返回值：

类型	说明
Promise<PrintTask>	打印完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

//传入文件的uri
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
//或者传入fd
//let files = ['fd://1', 'fd://2'];
print.print(files).then((printTask: print.PrintTask) => {
    printTask.on('succeed', () => {
        console.log('print state is succeed');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

print¹¹⁺

print(files: Array<string>, context: Context, callback: AsyncCallback<PrintTask>): void

打印接口，传入文件进行打印，使用callback异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
files	Array<string>	是	待打印文件列表，支持图片（.jpg .png .gif .bmp .webp）和pdf。系统应用传入uri时，需先调用uriPermissionManager.grantUriPermission()接口给打印应用授权，此接口为系统接口。三方应用建议使用print。
context	Context	是	用于拉起系统打印界面的UIAbilityContext
callback	AsyncCallback<PrintTask>	是	异步获取打印完成之后的回调

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

//传入文件的uri
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
//或者传入fd
//let files = ['fd://1', 'fd://2'];
let context = getContext(this);
print.print(files, context, (err: BusinessError, printTask: print.PrintTask) => {
    if (err) {
        console.log('print err ' + JSON.stringify(err));
    } else {
        printTask.on('succeed', () => {
            console.log('print state is succeed');
        })
        // ...
    }
})

print¹¹⁺

print(files: Array<string>, context: Context): Promise<PrintTask>

打印接口，传入文件进行打印，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
files	Array<string>	是	待打印文件列表，支持图片（.jpg .png .gif .bmp .webp）和pdf。系统应用传入uri时，需先调用uriPermissionManager.grantUriPermission()接口给打印应用授权，此接口为系统接口。三方应用建议使用print。
context	Context	是	用于拉起系统打印界面的UIAbilityContext

返回值：

类型	说明
Promise<PrintTask>	打印完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

//传入文件的uri
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
//或者传入fd
//let files = ['fd://1', 'fd://2'];
let context = getContext(this);
print.print(files, context).then((printTask: print.PrintTask) => {
    printTask.on('succeed', () => {
        console.log('print state is succeed');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

print¹¹⁺

print(jobName: string, printAdapter: PrintDocumentAdapter, printAttributes: PrintAttributes, context: Context): Promise<PrintTask>

打印接口，传入文件进行打印，三方应用需要更新打印文件，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
jobName	string	是	表示待打印文件名称，例如：test.pdf。打印侧会通过onStartLayoutWrite接口将空的pdf文件的fd传给接口调用方，由调用方使用新的打印参数更新待打印文件。
printAdapter	PrintDocumentAdapter	是	表示三方应用实现的PrintDocumentAdapter接口实例
printAttributes	PrintAttributes	是	表示打印参数
context	Context	是	用于拉起系统打印界面的UIAbilityContext

返回值：

类型	说明
Promise<PrintTask>	打印完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let jobName : string = "jobName";
let printAdapter : print.PrintDocumentAdapter | null = null;
let printAttributes : print.PrintAttributes = {
    copyNumber: 1,
    pageRange: {
        startPage: 0,
        endPage: 5,
        pages: []
    },
    pageSize: print.PrintPageType.PAGE_ISO_A3,
    directionMode: print.PrintDirectionMode.DIRECTION_MODE_AUTO,
    colorMode: print.PrintColorMode.COLOR_MODE_MONOCHROME,
    duplexMode: print.PrintDuplexMode.DUPLEX_MODE_NONE
}
let context = getContext();

print.print(jobName, printAdapter, printAttributes, context).then((printTask: print.PrintTask) => {
    printTask.on('succeed', () => {
        console.log('print state is succeed');
    })
    // ...
}).catch((error: BusinessError) => {
    console.log('print err ' + JSON.stringify(error));
})

PrintAttributes¹¹⁺

定义打印参数的接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

名称	类型	必填	说明
copyNumber	number	否	表示文件打印份数
pageRange	PrintPageRange	否	表示待打印文件的页面范围
pageSize	PrintPageSize \| PrintPageType	否	表示代打印文件的纸张类型
directionMode	PrintDirectionMode	否	表示待打印文件的方向
colorMode	PrintColorMode	否	表示待打印文件的色彩模式
duplexMode	PrintDuplexMode	否	表示待打印文件的单双面模式

PrintPageRange¹¹⁺

定义打印范围的接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

名称	类型	必填	说明
startPage	number	否	表示起始页
endPage	number	否	表示结束页
pages	Array<number>	否	表示待打印的页面范围的集合

PrintPageSize¹¹⁺

定义打印页面尺寸的接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

名称	类型	必填	说明
id	string	是	表示纸张类型ID
name	string	是	表示纸张类型名称
width	number	是	表示页面宽度，单位：毫米
height	number	是	表示页面高度，单位：毫米

PrintDirectionMode¹¹⁺

打印纸张方向的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
DIRECTION_MODE_AUTO	0	表示自动选择纸张方向
DIRECTION_MODE_PORTRAIT	1	表示纵向打印
DIRECTION_MODE_LANDSCAPE	2	表示横向打印

PrintColorMode¹¹⁺

打印色彩模式的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
COLOR_MODE_MONOCHROME	0	表示黑白打印
COLOR_MODE_COLOR	1	表示彩色打印

PrintDuplexMode¹¹⁺

打印单双面模式的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
DUPLEX_MODE_NONE	0	表示单面打印
DUPLEX_MODE_LONG_EDGE	1	表示双面打印沿长边翻转
DUPLEX_MODE_SHORT_EDGE	2	表示双面打印沿短边翻转

PrintPageType¹¹⁺

打印纸张类型的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PAGE_ISO_A3	0	表示A3
PAGE_ISO_A4	1	表示A4
PAGE_ISO_A5	2	表示A5
PAGE_JIS_B5	3	表示B5
PAGE_ISO_C5	4	表示C5
PAGE_ISO_DL	5	表示DL
PAGE_LETTER	6	表示Letter
PAGE_LEGAL	7	表示Legal
PAGE_PHOTO_4X6	8	表示4x6相纸
PAGE_PHOTO_5X7	9	表示5x7相纸
PAGE_INT_DL_ENVELOPE	10	表示INT DL ENVELOPE
PAGE_B_TABLOID	11	表示B Tabloid

PrintDocumentAdapterState¹¹⁺

打印任务状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PREVIEW_DESTROY	0	表示预览失败
PRINT_TASK_SUCCEED	1	表示打印任务成功
PRINT_TASK_FAIL	2	表示打印任务失败
PRINT_TASK_CANCEL	3	表示打印任务取消
PRINT_TASK_BLOCK	4	表示打印任务阻塞

PrintFileCreationState¹¹⁺

打印文件创建状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PRINT_FILE_CREATED	0	表示打印文件创建成功
PRINT_FILE_CREATION_FAILED	1	表示打印文件创建失败
PRINT_FILE_CREATED_UNRENDERED	2	表示打印文件创建成功但未渲染

PrinterState¹⁴⁺

打印机状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PRINTER_ADDED	0	表示新打印机到达
PRINTER_REMOVED	1	表示打印机丢失
PRINTER_CAPABILITY_UPDATED	2	表示打印机更新
PRINTER_CONNECTED	3	表示打印机已连接
PRINTER_DISCONNECTED	4	表示打印机已断开连接
PRINTER_RUNNING	5	表示打印机正在运行

PrintJobState¹⁴⁺

打印任务状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PRINT_JOB_PREPARE	0	表示打印任务的初始状态
PRINT_JOB_QUEUED	1	表示打印任务传送到打印机
PRINT_JOB_RUNNING	2	表示执行打印任务
PRINT_JOB_BLOCKED	3	表示打印任务已被阻止
PRINT_JOB_COMPLETED	4	表示打印任务完成

PrintJobSubState¹⁴⁺

打印任务子状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PRINT_JOB_COMPLETED_SUCCESS	0	表示打印任务成功
PRINT_JOB_COMPLETED_FAILED	1	表示打印任务失败
PRINT_JOB_COMPLETED_CANCELLED	2	表示打印任务已取消
PRINT_JOB_COMPLETED_FILE_CORRUPTED	3	表示打印任务已损坏
PRINT_JOB_BLOCK_OFFLINE	4	表示打印处于离线状态
PRINT_JOB_BLOCK_BUSY	5	表示打印被其他进程占用
PRINT_JOB_BLOCK_CANCELLED	6	表示打印任务已取消
PRINT_JOB_BLOCK_OUT_OF_PAPER	7	表示打印纸张用完
PRINT_JOB_BLOCK_OUT_OF_INK	8	表示打印墨水用完
PRINT_JOB_BLOCK_OUT_OF_TONER	9	表示打印墨粉用完
PRINT_JOB_BLOCK_JAMMED	10	表示打印卡纸
PRINT_JOB_BLOCK_DOOR_OPEN	11	表示打印盖开启
PRINT_JOB_BLOCK_SERVICE_REQUEST	12	表示打印服务请求
PRINT_JOB_BLOCK_LOW_ON_INK	13	表示打印墨水不足
PRINT_JOB_BLOCK_LOW_ON_TONER	14	表示打印墨粉不足
PRINT_JOB_BLOCK_REALLY_LOW_ON_INK	15	表示打印墨水量非常低
PRINT_JOB_BLOCK_BAD_CERTIFICATE	16	表示打印证书有误
PRINT_JOB_BLOCK_ACCOUNT_ERROR	18	表示打印账户时出错
PRINT_JOB_BLOCK_PRINT_PERMISSION_ERROR	19	表示打印许可异常
PRINT_JOB_BLOCK_PRINT_COLOR_PERMISSION_ERROR	20	表示彩色打印权限异常
PRINT_JOB_BLOCK_NETWORK_ERROR	21	表示设备未连接到网络
PRINT_JOB_BLOCK_SERVER_CONNECTION_ERROR	22	表示无法连接服务器
PRINT_JOB_BLOCK_LARGE_FILE_ERROR	23	表示打印大文件异常
PRINT_JOB_BLOCK_FILE_PARSING_ERROR	24	表示文件分析异常
PRINT_JOB_BLOCK_SLOW_FILE_CONVERSION	25	表示文件转换太慢
PRINT_JOB_RUNNING_UPLOADING_FILES	26	表示正在上传文件
PRINT_JOB_RUNNING_CONVERTING_FILES	27	表示正在转换文件
PRINT_JOB_BLOCK_UNKNOWN	99	表示打印未知问题

PrintErrorCode¹⁴⁺

打印错误代码的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
E_PRINT_NONE	0	表示没有错误
E_PRINT_NO_PERMISSION	201	表示没有许可
E_PRINT_INVALID_PARAMETER	401	表示无效的参数
E_PRINT_GENERIC_FAILURE	13100001	表示一般打印失败
E_PRINT_RPC_FAILURE	13100002	表示RPC失败
E_PRINT_SERVER_FAILURE	13100003	表示打印服务失败
E_PRINT_INVALID_EXTENSION	13100004	表示打印扩展无效
E_PRINT_INVALID_PRINTER	13100005	表示打印机无效
E_PRINT_INVALID_PRINT_JOB	13100006	表示打印任务无效
E_PRINT_FILE_IO	13100007	表示文件输入/输出错误

ApplicationEvent¹⁴⁺

打印应用事件的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
APPLICATION_CREATED	0	表示打印应用被拉起的事件
APPLICATION_CLOSED_FOR_STARTED	1	表示由于点击打印而关于打印应用的事件
APPLICATION_CLOSED_FOR_CANCELED	2	表示由于点击取消而关闭打印应用的事件

addPrinterToDiscovery¹⁴⁺

addPrinterToDiscovery(printerInformation: PrinterInformation): Promise<void>

添加打印机到系统打印机发现列表，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
printerInformation	PrinterInformation	是	表示新发现的打印机

返回值：

类型	说明
Promise<void>	添加打印机到系统打印机发现列表完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let printerInformation : print.PrinterInformation = {
    printerId : 'testPrinterId',
    printerName : 'testPrinterName',
    printerStatus : 0,
    description : 'testDesc',
    uri : 'testUri',
    printerMake : 'testPrinterMake',
    options : 'testOps'
};
print.addPrinterToDiscovery(printerInformation).then((data : void) => {
    console.log('addPrinterToDiscovery data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('addPrinterToDiscovery error : ' + JSON.stringify(error));
})

updatePrinterInDiscovery¹⁴⁺

updatePrinterInDiscovery(printerInformation: PrinterInformation): Promise<void>

更新打印机能力到系统打印机发现列表，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
printerInformation	PrinterInformation	是	表示待更新能力的打印机

返回值：

类型	说明
Promise<void>	更新打印机能力到系统打印机发现列表完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let testPageSize : print.PrintPageSize = {
    id : 'ISO_A4',
    name : 'iso_a4_210x297mm',
    width : 8268,
    height : 11692
};

let testCapability : print.PrinterCapabilities = {
    supportedPageSizes : [testPageSize],
    supportedColorModes : [print.PrintColorMode.COLOR_MODE_MONOCHROME],
    supportedDuplexModes : [print.PrintDuplexMode.DUPLEX_MODE_NONE],
    supportedMediaTypes : ['stationery'],
    supportedQualities : [print.PrintQuality.QUALITY_NORMAL],
    supportedOrientations : [print.PrintOrientationMode.ORIENTATION_MODE_PORTRAIT],
    options : 'testOptions'
};

let printerInformation : print.PrinterInformation = {
    printerId : 'testPrinterId',
    printerName : 'testPrinterName',
    printerStatus : 0,
    description : 'testDesc',
    capability ： testCapability,
    uri : 'testUri',
    printerMake : 'testPrinterMake',
    options : 'testOptions'
};
print.updatePrinterInDiscovery(printerInformation).then((data : void) => {
    console.log('updatePrinterInDiscovery data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('updatePrinterInDiscovery error : ' + JSON.stringify(error));
})

removePrinterFromDiscovery¹⁴⁺

removePrinterFromDiscovery(printerId: string): Promise<void>

从系统打印机发现列表里移除打印机，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
printerId	string	是	表示待移除的打印机

返回值：

类型	说明
Promise<void>	从系统打印机发现列表里移除打印机完成结果

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let printerId : string = 'testPrinterId';
print.removePrinterFromDiscovery(printerId).then((data : void) => {
    console.log('removePrinterFromDiscovery data : ' + JSON.stringify(data));
}).catch((error: BusinessError) => {
    console.log('removePrinterFromDiscovery error : ' + JSON.stringify(error));
})

getPrinterInformationById¹⁴⁺

getPrinterInformationById(printerId: string): Promise<PrinterInformation>

根据打印机id获取打印机信息，使用Promise异步回调。

需要权限： ohos.permission.PRINT

系统能力： SystemCapability.Print.PrintFramework

参数：

参数名	类型	必填	说明
printerId	string	是	表示待获取信息的打印机id

返回值：

类型	说明
Promise<PrinterInformation>	根据打印机id获取的对应打印机信息

错误码：

以下错误码的详细介绍请参见打印服务错误码。

错误码ID	错误信息
201	the application does not have permission to call this function.
401	Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types.

示例：

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

let printerId : string = 'testPrinterId';
print.getPrinterInformationById(printerId).then((printerInformation : print.PrinterInformation) => {
    console.log('getPrinterInformationById data : ' + JSON.stringify(printerInformation));
}).catch((error: BusinessError) => {
    console.log('getPrinterInformationById error : ' + JSON.stringify(error));
})

PrinterInformation¹⁴⁺

定义打印机信息的接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

名称	类型	必填	说明
printerId	string	是	表示打印机ID
printerName	string	是	表示打印机名称
printerStatus	PrinterStatus	是	表示当前打印机状态
description	string	否	表示打印机说明
capability	PrinterCapabilities	否	表示打印机能力
uri	string	否	表示打印机uri
printerMake	string	否	表示打印机型号
options	string	否	表示打印机详细信息

PrinterCapabilities¹⁴⁺

定义打印机能力的接口。

系统能力： SystemCapability.Print.PrintFramework

属性：

名称	类型	必填	说明
supportedPageSizes	Array<PrintPageSize>	是	表示打印机支持的纸张尺寸列表
supportedColorModes	Array<PrintColorMode>	是	表示打印机支持的色彩模式列表
supportedDuplexModes	Array<PrintDuplexMode>	是	表示打印机支持的单双面模式列表
supportedMediaTypes	Array<string>	否	表示打印机支持的纸张类型列表
supportedQualities	Array<PrintQuality>	否	表示打印机支持的打印质量列表
supportedOrientations	Array<PrintOrientationMode>	否	表示打印机支持的打印方向列表
options	string	否	表示打印机能力详细信息

PrintQuality¹⁴⁺

打印质量的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
QUALITY_DRAFT	3	表示经济的打印质量
QUALITY_NORMAL	4	表示标准的打印质量
QUALITY_HIGH	5	表示最佳的打印质量

PrintOrientationMode¹⁴⁺

打印方向的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
ORIENTATION_MODE_PORTRAIT	0	表示横向打印
ORIENTATION_MODE_LANDSCAPE	1	表示纵向打印
ORIENTATION_MODE_REVERSE_LANDSCAPE	2	表示纵向翻转打印
ORIENTATION_MODE_REVERSE_PORTRAIT	3	表示横向翻转打印
ORIENTATION_MODE_NONE	4	表示自适应方向打印

PrinterStatus¹⁴⁺

打印机状态的枚举。

系统能力： SystemCapability.Print.PrintFramework

名称	值	说明
PRINTER_IDLE	0	表示打印机空闲状态
PRINTER_BUSY	1	表示打印机忙碌状态
PRINTER_UNAVAILABLE	2	表示打印机脱机状态

@ohos.print (打印)

导入模块

PrintTask

on

on

on

on

off

off

off

off

PrintDocumentAdapter11+

onStartLayoutWrite

onJobStateChanged

print

print

print11+

print11+

print11+

PrintAttributes11+

PrintPageRange11+

PrintPageSize11+

PrintDirectionMode11+

PrintColorMode11+

PrintDuplexMode11+

PrintPageType11+

PrintDocumentAdapterState11+

PrintFileCreationState11+

PrinterState14+

PrintJobState14+

PrintJobSubState14+

PrintErrorCode14+

ApplicationEvent14+

addPrinterToDiscovery14+

updatePrinterInDiscovery14+

removePrinterFromDiscovery14+

getPrinterInformationById14+

PrinterInformation14+

PrinterCapabilities14+

PrintQuality14+

PrintOrientationMode14+

PrinterStatus14+

PrintDocumentAdapter¹¹⁺

print¹¹⁺

print¹¹⁺

print¹¹⁺

PrintAttributes¹¹⁺

PrintPageRange¹¹⁺

PrintPageSize¹¹⁺

PrintDirectionMode¹¹⁺

PrintColorMode¹¹⁺

PrintDuplexMode¹¹⁺

PrintPageType¹¹⁺

PrintDocumentAdapterState¹¹⁺

PrintFileCreationState¹¹⁺

PrinterState¹⁴⁺

PrintJobState¹⁴⁺

PrintJobSubState¹⁴⁺

PrintErrorCode¹⁴⁺

ApplicationEvent¹⁴⁺

addPrinterToDiscovery¹⁴⁺

updatePrinterInDiscovery¹⁴⁺

removePrinterFromDiscovery¹⁴⁺

getPrinterInformationById¹⁴⁺

PrinterInformation¹⁴⁺

PrinterCapabilities¹⁴⁺

PrintQuality¹⁴⁺

PrintOrientationMode¹⁴⁺

PrinterStatus¹⁴⁺