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 |
Blocks the print job. |
Boolean |
cancel() Cancels the print job. |
Boolean |
complete() Completes the print job. |
Boolean |
Indicates whether some other object is "equal to" this one. |
Boolean |
Fails the print job. |
Int |
getAdvancedIntOption(key: String!) Gets the value of an advanced (printer specific) print option. |
String! |
getAdvancedStringOption(key: String!) Gets the value of an advanced (printer specific) print option. |
PrintDocument |
Gets the printed document. |
PrintJobId! |
getId() Gets the unique print job id. |
PrintJobInfo |
getInfo() Gets the |
String? |
getTag() Gets the print job tag. |
Boolean |
hasAdvancedOption(key: String!) Gets whether this job has a given advanced (printer specific) print option. |
Int |
hashCode() |
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 |
isFailed() Gets whether this print job is failed. |
Boolean |
isQueued() 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 |
setStatus(status: CharSequence?) Sets the status of this print job. |
Unit |
Sets the status of this print job as a string resource. |
Boolean |
Sets a tag that is valid in the context of a |
Boolean |
start() Starts the print job. |
Public methods
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.
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. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the job is canceled. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the job as completed. |
See Also
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
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. |
See Also
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.
Parameters | |
---|---|
key |
String!: The option key. |
Return | |
---|---|
Int |
The option value. |
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.
Parameters | |
---|---|
key |
String!: The option key. |
Return | |
---|---|
String! |
The option value. |
getDocument
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
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
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
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
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. |
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.
Return | |
---|---|
Boolean |
Whether the print job is blocked. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the print job is cancelled. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the print job is completed. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the print job is failed. |
See Also
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.
Return | |
---|---|
Boolean |
Whether the print job is queued. |
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.
Return | |
---|---|
Boolean |
Whether the print job is started. |
See Also
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.
Parameters | |
---|---|
progress |
Float: The new progress Value is between 0.0 and 1.0 inclusive |
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.
This overrides any previously set status set viasetStatus(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
fun setStatus(statusResId: Int): Unit
Sets the status of this print job as a string resource.
This overrides any previously set status set viasetStatus(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
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
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. |
See Also