• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.PrintExtensionAbility (打印扩展能力)
2
3<!--Kit: Basic Services Kit-->
4<!--Subsystem: Print-->
5<!--Owner: @guoshengbang-->
6<!--Designer: @gcw_4D6e0BBd-->
7<!--Tester: @guoshengbang-->
8<!--Adviser: @RayShih-->
9
10该模块为打印扩展能力的操作API，提供调用打印扩展能力的接口。
11
12> **说明：**
13> 本模块首批接口从API version 14开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
14> 本模块接口仅可在Stage模型下使用。
15
16## 导入模块
17
18```ts
19import { PrintExtensionAbility } from '@kit.BasicServicesKit';
20```
21
22## PrintExtensionAbility.onCreate
23
24onCreate(want: Want): void
25
26初始化扩展能力，会在系统首次连接打印扩展时调用。
27
28**系统能力：** SystemCapability.Print.PrintFramework
29
30**参数：**
31| **参数名** | **类型** | **必填** | **说明** |
32| -------- | -------- | -------- | -------- |
33| want | Want | 是 | 表示调用打印页面需要参数 |
34
35**示例：**
36
37```ts
38import { PrintExtensionAbility } from '@kit.BasicServicesKit';
39import Want from '@ohos.app.ability.Want';
40
41export default class HWPrintExtension extends PrintExtensionAbility {
42    onCreate(want: Want): void {
43        console.log('onCreate');
44        // ...
45    }
46}
47```
48
49## PrintExtensionAbility.onStartDiscoverPrinter
50
51onStartDiscoverPrinter(): void
52
53开始发现与设备连接的打印机时调用。
54
55**系统能力：** SystemCapability.Print.PrintFramework
56
57**示例：**
58
59```ts
60import { PrintExtensionAbility } from '@kit.BasicServicesKit';
61
62export default class HWPrintExtension extends PrintExtensionAbility {
63    onStartDiscoverPrinter(): void {
64        console.log('onStartDiscoverPrinter enter');
65        // ...
66    }
67}
68```
69
70## PrintExtensionAbility.onStopDiscoverPrinter
71
72onStopDiscoverPrinter(): void
73
74停止发现打印机时调用。
75
76**系统能力：** SystemCapability.Print.PrintFramework
77
78**示例：**
79
80```ts
81import { PrintExtensionAbility } from '@kit.BasicServicesKit';
82
83export default class HWPrintExtension extends PrintExtensionAbility {
84    onStopDiscoverPrinter(): void {
85        console.log('onStopDiscoverPrinter enter');
86        // ...
87    }
88}
89```
90
91## PrintExtensionAbility.onConnectPrinter
92
93onConnectPrinter(printerId: number): void
94
95连接到特定打印机时调用。
96
97**系统能力：** SystemCapability.Print.PrintFramework
98
99**参数：**
100| **参数名** | **类型** | **必填** | **说明** |
101| -------- | -------- | -------- | -------- |
102| printerId | number | 是 | 表示打印机ID |
103
104**示例：**
105
106```ts
107import { PrintExtensionAbility } from '@kit.BasicServicesKit';
108
109export default class HWPrintExtension extends PrintExtensionAbility {
110    onConnectPrinter(printerId: number): void {
111        console.log('onConnectPrinter enter');
112        // ...
113    }
114}
115```
116
117## PrintExtensionAbility.onDisconnectPrinter
118
119onDisconnectPrinter(printerId: number): void
120
121断开与特定打印机的连接时调用。
122
123**系统能力：** SystemCapability.Print.PrintFramework
124
125**参数：**
126| **参数名** | **类型** | **必填** | **说明** |
127| -------- | -------- | -------- | -------- |
128| printerId | number | 是 | 表示打印机ID |
129
130**示例：**
131
132```ts
133import { PrintExtensionAbility } from '@kit.BasicServicesKit';
134
135export default class HWPrintExtension extends PrintExtensionAbility {
136    onDisconnectPrinter(printerId: number): void {
137        console.log('onDisconnectPrinter enter');
138        // ...
139    }
140}
141```
142
143## PrintExtensionAbility.onDestroy
144
145onDestroy(): void
146
147结束打印扩展时调用。
148
149**系统能力：** SystemCapability.Print.PrintFramework
150
151**示例：**
152
153```ts
154import { PrintExtensionAbility } from '@kit.BasicServicesKit';
155
156export default class HWPrintExtension extends PrintExtensionAbility {
157    onDestroy(): void {
158        console.log('onDestroy');
159    }
160}
161```
162