PrintJob

block

fun block(reason: String?): Boolean

Blocks the print job. You should call this method if isStarted() returns true and you need to block the print job. For example, the user has to add some paper to continue printing. To resume the print job call start(). To change the reason call setStatus(java.lang.CharSequence).
This method must be called from the main thread of your app.

cancel

fun cancel(): Boolean

Cancels the print job. You should call this method if isQueued() or or #isBlocked() returns true and you canceled the print job as a response to a call to PrintService.onRequestCancelPrintJob(PrintJob).
This method must be called from the main thread of your app.

complete

fun complete(): Boolean

Completes the print job. You should call this method if isStarted() returns true and you are done printing.
This method must be called from the main thread of your app.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

fail

fun fail(error: String?): Boolean

Fails the print job. You should call this method if isQueued() or isStarted() or isBlocked() returns true you failed while printing.
This method must be called from the main thread of your app.

getAdvancedIntOption

fun getAdvancedIntOption(key: String!): Int

Gets the value of an advanced (printer specific) print option.
This method must be called from the main thread of your app.

getAdvancedStringOption

fun getAdvancedStringOption(key: String!): String!

Gets the value of an advanced (printer specific) print option.
This method must be called from the main thread of your app.

getDocument

fun getDocument(): PrintDocument

Gets the printed document.
This method must be called from the main thread of your app.

getId

fun getId(): PrintJobId!

Gets the unique print job id.
This method must be called from the main thread of your app.

getInfo

fun getInfo(): PrintJobInfo

Gets the PrintJobInfo that describes this job.

Node:The returned info object is a snapshot of the current print job state. Every call to this method returns a fresh info object that reflects the current print job state.

getTag

fun getTag(): String?

Gets the print job tag.
This method must be called from the main thread of your app.

hasAdvancedOption

fun hasAdvancedOption(key: String!): Boolean

Gets whether this job has a given advanced (printer specific) print option.
This method must be called from the main thread of your app.

hashCode

fun hashCode(): Int

isBlocked

fun isBlocked(): Boolean

Gets whether this print job is blocked. Such a print job is halted due to an abnormal condition and can be started or canceled or failed.
This method must be called from the main thread of your app.

isCancelled

fun isCancelled(): Boolean

Gets whether this print job is cancelled. Such a print job was cancelled as a result of a user request. This is a final state.
This method must be called from the main thread of your app.

isCompleted

fun isCompleted(): Boolean

Gets whether this print job is completed. Such a print job is successfully printed. This is a final state.
This method must be called from the main thread of your app.

isFailed

fun isFailed(): Boolean

Gets whether this print job is failed. Such a print job is not successfully printed due to an error. This is a final state.
This method must be called from the main thread of your app.

isQueued

fun isQueued(): Boolean

Gets whether this print job is queued. Such a print job is ready to be printed and can be started or cancelled.
This method must be called from the main thread of your app.

isStarted

fun isStarted(): Boolean

Gets whether this print job is started. Such a print job is being printed and can be completed or canceled or failed.
This method must be called from the main thread of your app.

setProgress

fun setProgress(progress: Float): Unit

Sets the progress of this print job as a fraction of 1.
This method must be called from the main thread of your app.

setStatus

fun setStatus(statusResId: Int): Unit

Sets the status of this print job as a string resource.

setStatus

fun setStatus(status: CharSequence?): Unit

Sets the status of this print job. This should be a human readable, short, and translated description of the current state of the print job.

setTag

fun setTag(tag: String): Boolean

Sets a tag that is valid in the context of a PrintService and is not interpreted by the system. For example, a print service may set as a tag the key of the print job returned by a remote print server, if the printing is off handed to a cloud based service.
This method must be called from the main thread of your app.

start

fun start(): Boolean

Starts the print job. You should call this method if isQueued() or isBlocked() returns true and you started resumed printing.

This resets the print status to null. Set the new status by using #setStatus.