Added in API level 19

PrintJob


class PrintJob
kotlin.Any
   ↳ android.printservice.PrintJob

This class represents a print job from the perspective of a print service. It provides APIs for observing the print job state and performing operations on the print job.

Note: All methods of this class must be invoked on the main application thread.

Summary

Public methods
Boolean
block(reason: String?)

Blocks the print job.

Boolean

Cancels the print job.

Boolean

Completes the print job.

Boolean
equals(other: Any?)

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

Boolean
fail(error: String?)

Fails the print job.

Int

Gets the value of an advanced (printer specific) print option.

String!

Gets the value of an advanced (printer specific) print option.

PrintDocument

Gets the printed document.

PrintJobId!

Gets the unique print job id.

PrintJobInfo

Gets the PrintJobInfo that describes this job.

String?

Gets the print job tag.

Boolean

Gets whether this job has a given advanced (printer specific) print option.

Int

Boolean

Gets whether this print job is blocked.

Boolean

Gets whether this print job is cancelled.

Boolean

Gets whether this print job is completed.

Boolean

Gets whether this print job is failed.

Boolean

Gets whether this print job is queued.

Boolean

Gets whether this print job is started.

Unit
setProgress(progress: Float)

Sets the progress of this print job as a fraction of 1.

Unit

Sets the status of this print job.

Unit
setStatus(statusResId: Int)

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

Boolean
setTag(tag: String)

Sets a tag that is valid in the context of a PrintService and is not interpreted by the system.

Boolean

Starts the print job.

Public methods

block

Added in API level 19
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.

Parameters
reason String?: The human readable, short, and translated reason why the print job is blocked. This value may be null.
Return
Boolean Whether the job was blocked.

cancel

Added in API level 19
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.

Return
Boolean Whether the job is canceled.

complete

Added in API level 19
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.

Return
Boolean Whether the job as completed.

See Also

equals

Added in API level 19
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.

Parameters
obj This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

fail

Added in API level 19
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.

Parameters
error String?: The human readable, short, and translated reason for the failure. This value may be null.
Return
Boolean Whether the job was failed.

getAdvancedIntOption

Added in API level 19
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.

Parameters
key String!: The option key.
Return
Int The option value.

getAdvancedStringOption

Added in API level 19
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.

Parameters
key String!: The option key.
Return
String! The option value.

getDocument

Added in API level 19
fun getDocument(): PrintDocument

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

Return
PrintDocument The document. This value cannot be null.

getId

Added in API level 19
fun getId(): PrintJobId!

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

Return
PrintJobId! The id.

getInfo

Added in API level 19
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.


This method must be called from the main thread of your app.
Return
PrintJobInfo The print job info. This value cannot be null.

getTag

Added in API level 19
fun getTag(): String?

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

Return
String? The tag or null.

See Also

hasAdvancedOption

Added in API level 19
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.

Parameters
key String!: The option key.
Return
Boolean Whether the option is present.

hashCode

Added in API level 19
fun hashCode(): Int
Return
Int a hash code value for this object.

isBlocked

Added in API level 19
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.

Return
Boolean Whether the print job is blocked.

isCancelled

Added in API level 19
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.

Return
Boolean Whether the print job is cancelled.

See Also

isCompleted

Added in API level 19
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.

Return
Boolean Whether the print job is completed.

See Also

isFailed

Added in API level 19
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.

Return
Boolean Whether the print job is failed.

See Also

isQueued

Added in API level 19
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.

Return
Boolean Whether the print job is queued.

See Also

isStarted

Added in API level 19
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.

Return
Boolean Whether the print job is started.

setProgress

Added in API level 24
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.

Parameters
progress Float: The new progress Value is between 0.0 and 1.0 inclusive

setStatus

Added in API level 24
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.

This overrides any previously set status set via setStatus(java.lang.CharSequence), setStatus(int), block(java.lang.String), or fail(java.lang.String),
This method must be called from the main thread of your app.
Parameters
status CharSequence?: The new status. If null the status will be empty.

setStatus

Added in API level 24
fun setStatus(statusResId: Int): Unit

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

This overrides any previously set status set via setStatus(java.lang.CharSequence), setStatus(int), block(java.lang.String), or fail(java.lang.String),
This method must be called from the main thread of your app.
Parameters
statusResId Int: The new status as a String resource. If 0 the status will be empty.

setTag

Added in API level 19
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.

Parameters
tag String: The tag. This value cannot be null.
Return
Boolean True if the tag was set, false otherwise.

start

Added in API level 19
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.


This method must be called from the main thread of your app.
Return
Boolean Whether the job was started.