@ohos.print (Print)

The print module provides APIs for basic print operations.

NOTE The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

PrintTask

Implements event listeners for print tasks.

on

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

Registers a listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'block', indicating blocking of the print task.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Registers a listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'succeed', indicating success of the print task.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Registers a listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'fail', indicating failure of the print task.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Registers a listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'cancel', indicating canceling of the print task.
callback	Callback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Unregisters the listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'block', indicating blocking of the print task.
callback	Callback<void>	No	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Unregisters the listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'succeed', indicating success of the print task.
callback	Callback<void>	No	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Unregisters the listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'fail', indicating failure of the print task.
callback	Callback<void>	No	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Unregisters the listener for the print task blocking event. This API uses a callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Listening type. The value is fixed at 'cancel', indicating canceling of the print task.
callback	Callback<void>	No	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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¹¹⁺

Provides information about the document to print. This API must be implemented by a third-party application.

onStartLayoutWrite

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

Sends an empty PDF file descriptor to a third-party application. The third-party application updates the file with the new print attributes and then calls writeResultCallback to print the file.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
jobId	string	Yes	ID of the print job.
oldAttrs	PrintAttributes	Yes	Old print attributes.
newAttrs	PrintAttributes	Yes	New print attributes.
fd	number	Yes	PDF file descriptor sent to the API caller.
writeResultCallback	(jobId: string, writeResult: PrintFileCreationState)	Yes	Callback used to print the updated file.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Registers a listener for print job state changes.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
jobId	string	Yes	ID of the print job.
state	PrintDocumentAdapterState	Yes	New state of the print job.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

Prints files. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
files	Array<string>	Yes	List of files to print. Images (in .jpg, .png, .gif, .bmp, or .webp format) and PDF files are supported. Before a system application passes in the URI, it needs to call the uriPermissionManager.grantUriPermission() API to authorize the print application. This API is a system API. print is recommended for third-party application.
callback	AsyncCallback<PrintTask>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

// Pass in the URIs of the files.
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
// Alternatively, pass in the 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>

Prints files. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
files	Array<string>	Yes	List of files to print. Images (in .jpg, .png, .gif, .bmp, or .webp format) and PDF files are supported. Before a system application passes in the URI, it needs to call the uriPermissionManager.grantUriPermission() API to authorize the print application. This API is a system API. print is recommended for third-party application.

Return value

Type	Description
Promise<PrintTask>	Print result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

// Pass in the URIs of the files.
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
// Alternatively, pass in the 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

Prints files. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
files	Array<string>	Yes	List of files to print. Images (in .jpg, .png, .gif, .bmp, or .webp format) and PDF files are supported. Before a system application passes in the URI, it needs to call the uriPermissionManager.grantUriPermission() API to authorize the print application. This API is a system API. print is recommended for third-party application.
context	Context	Yes	UIAbilityContext used to start the system print UI.
callback	AsyncCallback<PrintTask>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

// Pass in the URIs of the files.
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
// Alternatively, pass in the 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>

Prints files. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
files	Array<string>	Yes	List of files to print. Images (in .jpg, .png, .gif, .bmp, or .webp format) and PDF files are supported. Before a system application passes in the URI, it needs to call uriPermissionManager.grantUriPermission() to authorize the print application. This API is a system API. print is recommended for third-party application.
context	Context	Yes	UIAbilityContext used to start the system print UI.

Return value

Type	Description
Promise<PrintTask>	Print result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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

// Pass in the URIs of the files.
let files = ['file://data/print/a.png', 'file://data/print/b.png'];
// Alternatively, pass in the 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>

Prints a file. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
jobName	string	Yes	Name of the file to print, for example, test.pdf. The printer uses the onStartLayoutWrite API to send the fd of the empty PDF file to the API caller. The API caller uses the new print attributes to update the file to print.
printAdapter	PrintDocumentAdapter	Yes	PrintDocumentAdapter API instance implemented by a third-party application.
printAttributes	PrintAttributes	Yes	Print attributes.
context	Context	Yes	UIAbilityContext used to start the system print UI.

Return value

Type	Description
Promise<PrintTask>	Print result.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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¹¹⁺

Defines the print attributes.

System capability: SystemCapability.Print.PrintFramework

Attributes

Name	Type	Mandatory	Description
copyNumber	number	No	Number of printed file copies.
pageRange	PrintPageRange	No	Page range of the file to print.
pageSize	PrintPageSize | PrintPageType	No	Page size of the file to print.
directionMode	PrintDirectionMode	No	Print direction mode.
colorMode	PrintColorMode	No	Color mode of the files to print.
duplexMode	PrintDuplexMode	No	Duplex mode of the files to print.

PrintPageRange¹¹⁺

Defines the print range.

System capability: SystemCapability.Print.PrintFramework

Attributes

Name	Type	Mandatory	Description
startPage	number	No	Start page.
endPage	number	No	End page.
pages	Array<number>	No	Page range set of the file to print.

PrintPageSize¹¹⁺

Defines the size of the printed page.

System capability: SystemCapability.Print.PrintFramework

Attributes

Name	Type	Mandatory	Description
id	string	Yes	Paper size ID.
name	string	Yes	Paper size name.
width	number	Yes	Page width, in millimeters.
height	number	Yes	Page height, in millimeters.

PrintDirectionMode¹¹⁺

Enumerates the print direction modes.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
DIRECTION_MODE_AUTO	0	Automatic.
DIRECTION_MODE_PORTRAIT	1	Portrait mode.
DIRECTION_MODE_LANDSCAPE	2	Landscape mode.

PrintColorMode¹¹⁺

Enumerates the color modes.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
COLOR_MODE_MONOCHROME	0	Black and white.
COLOR_MODE_COLOR	1	Color.

PrintDuplexMode¹¹⁺

Enumerates the duplex modes.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
DUPLEX_MODE_NONE	0	Simplex (single-sided).
DUPLEX_MODE_LONG_EDGE	1	Duplex (double-sided) with flipping on long edge.
DUPLEX_MODE_SHORT_EDGE	2	Duplex (double-sided) with flipping on short edge.

PrintPageType¹¹⁺

Enumerates the print page types.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
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	4 x 6 photo paper.
PAGE_PHOTO_5X7	9	5 x 7 photo paper.
PAGE_INT_DL_ENVELOPE	10	International envelope DL.
PAGE_B_TABLOID	11	B Tabloid.

PrintDocumentAdapterState¹¹⁺

Enumerates the print job states.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PREVIEW_DESTROY	0	The preview fails.
PRINT_TASK_SUCCEED	1	The print job is successful.
PRINT_TASK_FAIL	2	The print job is failed.
PRINT_TASK_CANCEL	3	The print job is canceled.
PRINT_TASK_BLOCK	4	The print job is blocked.

PrintFileCreationState¹¹⁺

Enumerates the print file creation status.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PRINT_FILE_CREATED	0	The print file is created successfully.
PRINT_FILE_CREATION_FAILED	1	The print file fails to be created.
PRINT_FILE_CREATED_UNRENDERED	2	The print file is successfully created but not rendered.

PrinterState¹⁴⁺

Enumerates the printer states.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PRINTER_ADDED	0	A new printer is added.
PRINTER_REMOVED	1	The printer is removed.
PRINTER_CAPABILITY_UPDATED	2	The printer is updated.
PRINTER_CONNECTED	3	The printer is connected.
PRINTER_DISCONNECTED	4	The printer is disconnected.
PRINTER_RUNNING	5	The printer is running.

PrintJobState¹⁴⁺

Enumerates the print job states.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PRINT_JOB_PREPARE	0	The printer is prepared for the print job.
PRINT_JOB_QUEUED	1	The print job is on the print queue of the printer.
PRINT_JOB_RUNNING	2	The print job is being executed.
PRINT_JOB_BLOCKED	3	The print job is blocked.
PRINT_JOB_COMPLETED	4	The print job is complete.

PrintJobSubState¹⁴⁺

Enumerates the print job substates.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PRINT_JOB_COMPLETED_SUCCESS	0	The print job is successful.
PRINT_JOB_COMPLETED_FAILED	1	The print job is failed.
PRINT_JOB_COMPLETED_CANCELLED	2	The print job is canceled by user.
PRINT_JOB_COMPLETED_FILE_CORRUPTED	3	The print job is corrupted.
PRINT_JOB_BLOCK_OFFLINE	4	The printer is offline.
PRINT_JOB_BLOCK_BUSY	5	The printer is occupied by another process.
PRINT_JOB_BLOCK_CANCELLED	6	The print job is canceled due to a block.
PRINT_JOB_BLOCK_OUT_OF_PAPER	7	The printer is out of paper.
PRINT_JOB_BLOCK_OUT_OF_INK	8	The printer is out of ink.
PRINT_JOB_BLOCK_OUT_OF_TONER	9	The printer is out of toner.
PRINT_JOB_BLOCK_JAMMED	10	The printer is in a paper jam.
PRINT_JOB_BLOCK_DOOR_OPEN	11	The printer door is open.
PRINT_JOB_BLOCK_SERVICE_REQUEST	12	Print service request.
PRINT_JOB_BLOCK_LOW_ON_INK	13	The printer is low on ink.
PRINT_JOB_BLOCK_LOW_ON_TONER	14	The printer is low on toner.
PRINT_JOB_BLOCK_REALLY_LOW_ON_INK	15	The printer is extremely low on ink.
PRINT_JOB_BLOCK_BAD_CERTIFICATE	16	The print certificate is incorrect.
PRINT_JOB_BLOCK_ACCOUNT_ERROR	18	There is an error with the printer account.
PRINT_JOB_BLOCK_PRINT_PERMISSION_ERROR	19	There is an error with the printer permission.
PRINT_JOB_BLOCK_PRINT_COLOR_PERMISSION_ERROR	20	There is an error with the color printing permission.
PRINT_JOB_BLOCK_NETWORK_ERROR	21	The printer fails to connect to the network.
PRINT_JOB_BLOCK_SERVER_CONNECTION_ERROR	22	The printer fails to connect to the server.
PRINT_JOB_BLOCK_LARGE_FILE_ERROR	23	There is an error with a large file printing.
PRINT_JOB_BLOCK_FILE_PARSING_ERROR	24	There is an error with file parsing.
PRINT_JOB_BLOCK_SLOW_FILE_CONVERSION	25	The file conversion is slow.
PRINT_JOB_RUNNING_UPLOADING_FILES	26	The file is uploading.
PRINT_JOB_RUNNING_CONVERTING_FILES	27	The file is converting.
PRINT_JOB_BLOCK_UNKNOWN	99	There is an unknown error with the printer.

PrintErrorCode¹⁴⁺

Enumerates the print error codes.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
E_PRINT_NONE	0	No error.
E_PRINT_NO_PERMISSION	201	No permission.
E_PRINT_INVALID_PARAMETER	401	Invalid parameters.
E_PRINT_GENERIC_FAILURE	13100001	Printing failure.
E_PRINT_RPC_FAILURE	13100002	RPC failure.
E_PRINT_SERVER_FAILURE	13100003	Print service failure.
E_PRINT_INVALID_EXTENSION	13100004	Invalid printer extension.
E_PRINT_INVALID_PRINTER	13100005	Invalid printer.
E_PRINT_INVALID_PRINT_JOB	13100006	Invalid print job.
E_PRINT_FILE_IO	13100007	Incorrect file input/output.

ApplicationEvent¹⁴⁺

Enumerates print application events.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
APPLICATION_CREATED	0	Starts the print application.
APPLICATION_CLOSED_FOR_STARTED	1	Closes the print application by clicking Start.
APPLICATION_CLOSED_FOR_CANCELED	2	Closes the print application by clicking Cancel.

addPrinterToDiscovery¹⁴⁺

addPrinterToDiscovery(printerInformation: PrinterInformation): Promise<void>

Adds a printer to the printer discovery list. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
printerInformation	PrinterInformation	Yes	The added printer.

Return value

Type	Description
Promise<void>	Result of adding a printer to the printer discovery list.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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>

Updates the printer capabilities to the printer discovery list. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
printerInformation	PrinterInformation	Yes	Printer whose capability is to be updated.

Return value

Type	Description
Promise<void>	Result of updating the printer capabilities to the printer discovery list.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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>

Removes a printer from the printer discovery list. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
printerId	string	Yes	Printer to remove.

Return value

Type	Description
Promise<void>	Result of removing a printer from the printer discovery list.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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>

Obtains printer information based on the printer ID. This API uses a promise to return the result.

Required permissions: ohos.permission.PRINT

System capability: SystemCapability.Print.PrintFramework

Parameters

Name	Type	Mandatory	Description
printerId	string	Yes	Printer ID used to obtain information.

Return value

Type	Description
Promise<PrinterInformation>	Printer information obtained based on the printer ID.

Error codes

For details about the error codes, see Error Codes of the Print Service.

ID	Error Message
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.

Example

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¹⁴⁺

Defines the printer information.

System capability: SystemCapability.Print.PrintFramework

Attributes

Name	Type	Mandatory	Description
printerId	string	Yes	Printer ID.
printerName	string	Yes	Printer name.
printerStatus	PrinterStatus	Yes	Printer state.
description	string	No	Printer description.
capability	PrinterCapabilities	No	Printer capabilities.
uri	string	No	Printer URI.
printerMake	string	No	Printer model.
options	string	No	Printer details.

PrinterCapabilities¹⁴⁺

Defines the printer capabilities.

System capability: SystemCapability.Print.PrintFramework

Attributes

Name	Type	Mandatory	Description
supportedPageSizes	Array<PrintPageSize>	Yes	List of paper sizes supported by the printer.
supportedColorModes	Array<PrintColorMode>	Yes	List of color modes supported by the printer.
supportedDuplexModes	Array<PrintDuplexMode>	Yes	List of single- and double-sided modes supported by the printer.
supportedMediaTypes	Array<string>	No	List of paper types supported by the printer.
supportedQualities	Array<PrintQuality>	No	List of print quality supported by the printer.
supportedOrientations	Array<PrintOrientationMode>	No	List of print directions supported by the printer.
options	string	No	Printer capability details.

PrintQuality¹⁴⁺

Enumerates the print qualities.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
QUALITY_DRAFT	3	Draft
QUALITY_NORMAL	4	Standard
QUALITY_HIGH	5	High

PrintOrientationMode¹⁴⁺

Enumerates the print directions.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
ORIENTATION_MODE_PORTRAIT	0	Portrait mode.
ORIENTATION_MODE_LANDSCAPE	1	Landscape mode.
ORIENTATION_MODE_REVERSE_LANDSCAPE	2	Reverse landscape mode.
ORIENTATION_MODE_REVERSE_PORTRAIT	3	Reverse portrait mode.
ORIENTATION_MODE_NONE	4	Adaptive mode.

PrinterStatus¹⁴⁺

Enumerates the printer states.

System capability: SystemCapability.Print.PrintFramework

Name	Value	Description
PRINTER_IDLE	0	Idle
PRINTER_BUSY	1	Busy
PRINTER_UNAVAILABLE	2	Unavailable