harmony 鸿蒙@ohos.app.ability.PrintExtensionAbility (打印扩展能力)

2023-10-30
浏览 (442)

@ohos.app.ability.PrintExtensionAbility (打印扩展能力)

该模块为打印扩展能力的操作API，提供调用打印扩展能力的接口。

说明：
本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口为系统接口。
本模块接口仅可在Stage模型下使用。

导入模块

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

onCreate

onCreate(want: Want): void

初始化扩展能力,会在系统首次连接打印扩展时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |want|Want|是|表示调用打印页面需要参数|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
import Want from '@ohos.app.ability.Want';

export default class HWPrintExtension extends PrintExtensionAbility {
    onCreate(want: Want): void {
        console.log('onCreate');
        // ...
    }
}

onStartDiscoverPrinter

onStartDiscoverPrinter(): void

开始发现与设备连接的打印机时调用。

系统能力： SystemCapability.Print.PrintFramework

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

export default class HWPrintExtension extends PrintExtensionAbility {
    onStartDiscoverPrinter(): void {
        console.log('onStartDiscoverPrinter enter');
        // ...
    }
}

onStopDiscoverPrinter

onStopDiscoverPrinter(): void

停止发现打印机时调用。

系统能力： SystemCapability.Print.PrintFramework

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

export default class HWPrintExtension extends PrintExtensionAbility {
    onStopDiscoverPrinter(): void {
        console.log('onStopDiscoverPrinter enter');
        // ...
    }
}

onConnectPrinter

onConnectPrinter(printerId: number): void

连接到特定打印机时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |printerId|number|是|表示打印机ID|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

export default class HWPrintExtension extends PrintExtensionAbility {
    onConnectPrinter(printerId: number): void {
        console.log('onConnectPrinter enter');
        // ...
    }
}

onDisconnectPrinter

onDisconnectPrinter(printerId: number): void

断开与特定打印机的连接时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |printerId|number|是|表示打印机ID|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

export default class HWPrintExtension extends PrintExtensionAbility {
    onDisconnectPrinter(printerId: number): void {
        console.log('onDisconnectPrinter enter');
        // ...
    }
}

onStartPrintJob

onStartPrintJob(jobInfo: print.PrintJob): void

开始打印任务时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |jobInfo|print.PrintJob|是|表示打印任务的信息|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
import print from '@ohos.print';

export default class HWPrintExtension extends PrintExtensionAbility {
    onStartPrintJob(jobInfo: print.PrintJob): void {
        console.log('onStartPrintJob, jobId is: ' + jobInfo.jobId);
        // ...
    }
}

onCancelPrintJob

onCancelPrintJob(jobInfo: print.PrintJob): void

移除已开始的打印任务时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |jobInfo|print.PrintJob|是|表示打印任务的信息|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
import print from '@ohos.print';

export default class HWPrintExtension extends PrintExtensionAbility {
    onCancelPrintJob(jobInfo: print.PrintJob): void {
        console.log('onCancelPrintJob, jobId is: ' + jobInfo.jobId);
        // ...
    }
}

onRequestPrinterCapability

onRequestPrinterCapability(printerId: number): print.PrinterCapability

请求打印机能力时调用。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |printerId|number|是|表示打印机ID|

返回值： |类型|说明| |——–|——–| |print.PrinterCapability|表示打印能力|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
import print from '@ohos.print';

export default class HWPrintExtension extends PrintExtensionAbility {
    onRequestPrinterCapability(printerId: number): print.PrinterCapability {
        console.log('onRequestPrinterCapability enter');
        // ...
        let tmp : print.PrinterCapability = {
            colorMode : 1,
            duplexMode : 1,
            pageSize : []
        };
        return tmp;
    }
}

onRequestPreview

onRequestPreview(jobInfo: print.PrintJob): string

请求预览时调用，并将结果返回到Print SA。

系统能力： SystemCapability.Print.PrintFramework

参数： |参数名|类型|必填|说明| |——–|——–|——–|——–| |jobInfo|print.PrintJob|是|表示打印任务信息|

返回值： |类型|说明| |——–|——–| |string|返回的预览结果|

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';
import print from '@ohos.print';

export default class HWPrintExtension extends PrintExtensionAbility {
    onRequestPreview(jobInfo: print.PrintJob): string {
        console.log('onRequestPreview enter');
        // ...
        let tmp : string = '';
        return tmp;
    }
}

onDestroy

onDestroy(): void

结束打印扩展时调用。

系统能力： SystemCapability.Print.PrintFramework

示例：

import PrintExtensionAbility from '@ohos.app.ability.PrintExtensionAbility';

export default class HWPrintExtension extends PrintExtensionAbility {
    onDestroy(): void {
        console.log('onDestroy');
    }
}