Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f2ff4b87
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
f2ff4b87
编写于
8月 28, 2023
作者:
O
openharmony_ci
提交者:
Gitee
8月 28, 2023
浏览文件
操作
浏览文件
下载
差异文件
!23242 【monthly_0815】打印添加接口文档
Merge pull request !23242 from xiongqiao3/monthly_20230815
上级
284ee5fc
7c7e5f60
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
190 addition
and
0 deletion
+190
-0
zh-cn/application-dev/reference/apis/Readme-CN.md
zh-cn/application-dev/reference/apis/Readme-CN.md
+1
-0
zh-cn/application-dev/reference/apis/js-apis-print.md
zh-cn/application-dev/reference/apis/js-apis-print.md
+189
-0
未找到文件。
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @
f2ff4b87
...
...
@@ -380,6 +380,7 @@
-
[
@ohos.InputMethodSubtype (输入法子类型)
](
js-apis-inputmethod-subtype.md
)
-
[
@ohos.logLibrary (维测日志获取)
](
js-apis-loglibrary.md
)
-
[
@ohos.pasteboard (剪贴板)
](
js-apis-pasteboard.md
)
-
[
@ohos.print (打印)
](
js-apis-print.md
)
-
[
@ohos.screenLock (锁屏管理)
](
js-apis-screen-lock.md
)
-
[
@ohos.systemDateTime (系统时间、时区)
](
js-apis-system-date-time.md
)
-
[
@ohos.systemTimer (系统定时器)
](
js-apis-system-timer.md
)
...
...
zh-cn/application-dev/reference/apis/js-apis-print.md
0 → 100644
浏览文件 @
f2ff4b87
# @ohos.print (打印)
该模块为基本打印的操作API,提供调用基础打印功能的接口。
> **说明:**
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
js
import
print
from
'
@ohos.print
'
;
```
## PrintTask
打印任务完成后的事件监听回调接口类
### on
on(type: 'block' | 'succeed' | 'fail' | 'cancel', callback: Callback
<
void
>
): void
注册打印完成后的监听,使用callback回调。
**需要权限:**
ohos.permission.PRINT
**系统能力:**
SystemCapability.Print.PrintFramework
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 注册监听,
<br/>
可选监听字段:block/succeed/fail/cancel
<br/>
依次表示打印:阻塞/成功/失败/取消 |
| callback| Callback
<
void
>
| 是 | 打印完成后处于相应状态的回调 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
PrintTask
>
| 打印完成结果 |
**示例:**
```
js
import
print
from
'
@ohos.print
'
;
let
file
=
[
'
file://data/print/a.png
'
,
'
file://data/print/b.png
'
];
print
.
print
(
file
).
then
((
printTask
)
=>
{
printTask
.
on
(
'
succeed
'
,
()
=>
{
console
.
log
(
'
print state is succeed
'
)
})
printTask
.
on
(
'
block
'
,
()
=>
{
console
.
log
(
'
print state is block
'
)
})
printTask
.
on
(
'
succeed
'
,
()
=>
{
console
.
log
(
'
print state is succeed
'
)
})
printTask
.
on
(
'
fail
'
,
()
=>
{
console
.
log
(
'
print state is fail
'
)
})
printTask
.
on
(
'
cancel
'
,
()
=>
{
console
.
log
(
'
print state is cancel
'
)
})
// ...
}).
catch
((
error
)
=>
{
console
.
log
(
'
print err
'
)
})
```
### off
off(type: 'block' | 'succeed' | 'fail' | 'cancel', callback?: Callback
<
void
>
): void
取消打印完成后的监听,使用callback回调。
**需要权限:**
ohos.permission.PRINT
**系统能力:**
SystemCapability.Print.PrintFramework
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| type | string | 是 | 取消监听,
<br/>
可选监听字段:block/succeed/fail/cancel
<br/>
依次表示打印:阻塞/成功/失败/取消 |
| callback| Callback
<
void
>
| 否 | 取消相应状态监听成功后的回调 |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
PrintTask
>
| 打印完成结果 |
**示例:**
```
js
import
print
from
'
@ohos.print
'
;
let
file
=
[
'
file://data/print/a.png
'
,
'
file://data/print/b.png
'
];
print
.
print
(
file
).
then
((
printTask
)
=>
{
printTask
.
off
(
'
succeed
'
,
()
=>
{
console
.
log
(
'
unregister state succeed
'
)
})
printTask
.
off
(
'
block
'
,
()
=>
{
console
.
log
(
'
unregister state block
'
)
})
printTask
.
off
(
'
succeed
'
,
()
=>
{
console
.
log
(
'
unregister state succeed
'
)
})
printTask
.
off
(
'
fail
'
,
()
=>
{
console
.
log
(
'
unregister state fail
'
)
})
printTask
.
off
(
'
cancel
'
,
()
=>
{
console
.
log
(
'
unregister state cancel
'
)
})
// ...
}).
catch
((
error
)
=>
{
console
.
log
(
'
print err
'
)
})
```
## print
print(files: Array
<
string
>
, callback: AsyncCallback
<
PrintTask
>
): void
打印接口,传入文件进行打印,使用callbak异步回调。
**需要权限:**
ohos.permission.PRINT
**系统能力:**
SystemCapability.Print.PrintFramework
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| file | Array
<
string
>
| 是 | 待打印文件列表,仅支持图片和pdf |
| callback| AsyncCallback
<
PrintTask
>
| 是 | 异步获取打印完成之后的回调 |
**示例:**
```
js
import
print
from
'
@ohos.print
'
;
//传入文件的uri
let
file
=
[
'
file://data/print/a.png
'
,
'
file://data/print/b.png
'
];
// 或者传入fd
// let file = ['fd://1', 'fd://2'];
print
.
print
(
file
,
(
err
,
printTask
:
print
.
PrintTask
)
=>
{
if
(
err
)
{
console
.
log
(
'
print 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
**参数:**
|
**参数名**
|
**类型**
|
**必填**
|
**说明**
|
| -------- | -------- | -------- | -------- |
| file | Array
<
string
>
| 是 | 待打印文件列表,仅支持图片和pdf |
**返回值:**
|
**类型**
|
**说明**
|
| -------- | -------- |
| Promise
<
PrintTask
>
| 打印完成结果 |
**示例:**
```
js
import
print
from
'
@ohos.print
'
;
//传入文件的uri
let
file
=
[
'
file://data/print/a.png
'
,
'
file://data/print/b.png
'
];
// 或者传入fd
// let file = ['fd://1', 'fd://2'];
print
.
print
(
file
).
then
((
printTask
)
=>
{
printTask
.
on
(
'
succeed
'
,
()
=>
{
console
.
log
(
'
print state is succeed
'
)
})
// ...
}).
catch
((
error
)
=>
{
console
.
log
(
'
print err
'
)
})
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录