• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.PrintExtensionAbility (Print Extension Ability)
2
3The **PrintExtensionAbility** module provides operation APIs of the print extension ability.
4
5> **NOTE**
6> The initial APIs of this module are supported since API version 14. Newly added APIs will be marked with a superscript to indicate their earliest API version.
7> The APIs of this module can be used only in the stage model.
8
9## Modules to Import
10
11```ts
12import { PrintExtensionAbility } from '@kit.BasicServicesKit';
13```
14
15## PrintExtensionAbility.onCreate
16
17onCreate(want: Want): void
18
19Called to initialize the print extension when the system connects to the extension for the first time.
20
21**System capability**: SystemCapability.Print.PrintFramework
22
23**Parameters**
24| **Name**| **Type** | **Mandatory**| **Description**|
25| -------- | -------- | -------- | -------- |
26| want | Want | Yes| Parameters required for invoking the print page.|
27
28**Example**
29
30```ts
31import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
32import Want from '@ohos.app.ability.Want';
33
34export default class HWPrintExtension extends PrintExtensionAbility {
35    onCreate(want: Want): void {
36        console.log('onCreate');
37        // ...
38    }
39}
40```
41
42## PrintExtensionAbility.onStartDiscoverPrinter
43
44onStartDiscoverPrinter(): void
45
46Called when an attempt to discover printers starts.
47
48**System capability**: SystemCapability.Print.PrintFramework
49
50**Example**
51
52```ts
53import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
54
55export default class HWPrintExtension extends PrintExtensionAbility {
56    onStartDiscoverPrinter(): void {
57        console.log('onStartDiscoverPrinter enter');
58        // ...
59    }
60}
61```
62
63## PrintExtensionAbility.onStopDiscoverPrinter
64
65onStopDiscoverPrinter(): void
66
67Called when the attempt to discover printers stops.
68
69**System capability**: SystemCapability.Print.PrintFramework
70
71**Example**
72
73```ts
74import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
75
76export default class HWPrintExtension extends PrintExtensionAbility {
77    onStopDiscoverPrinter(): void {
78        console.log('onStopDiscoverPrinter enter');
79        // ...
80    }
81}
82```
83
84## PrintExtensionAbility.onConnectPrinter
85
86onConnectPrinter(printerId: number): void
87
88Called when the device connects to the specified printer.
89
90**System capability**: SystemCapability.Print.PrintFramework
91
92**Parameters**
93| **Name**| **Type** | **Mandatory**| **Description**|
94| -------- | -------- | -------- | -------- |
95| printerId | number | Yes| Printer ID.|
96
97**Example**
98
99```ts
100import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
101
102export default class HWPrintExtension extends PrintExtensionAbility {
103    onConnectPrinter(printerId: number): void {
104        console.log('onConnectPrinter enter');
105        // ...
106    }
107}
108```
109
110## PrintExtensionAbility.onDisconnectPrinter
111
112onDisconnectPrinter(printerId: number): void
113
114Called when the device disconnects from the specified printer.
115
116**System capability**: SystemCapability.Print.PrintFramework
117
118**Parameters**
119| **Name**| **Type** | **Mandatory**| **Description**|
120| -------- | -------- | -------- | -------- |
121| printerId | number | Yes| Printer ID.|
122
123**Example**
124
125```ts
126import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
127
128export default class HWPrintExtension extends PrintExtensionAbility {
129    onDisconnectPrinter(printerId: number): void {
130        console.log('onDisconnectPrinter enter');
131        // ...
132    }
133}
134```
135
136## PrintExtensionAbility.onDestroy
137
138onDestroy(): void
139
140Called when the print extension ability is stopped.
141
142**System capability**: SystemCapability.Print.PrintFramework
143
144**Example**
145
146```ts
147import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
148
149export default class HWPrintExtension extends PrintExtensionAbility {
150    onDestroy(): void {
151        console.log('onDestroy');
152    }
153}
154```
155