Added in API level 19

PrinterInfo


class PrinterInfo : Parcelable
kotlin.Any
   ↳ android.print.PrinterInfo

This class represents the description of a printer. Instances of this class are created by print services to report to the system the printers they manage. The information of this class has two major components, printer properties such as name, id, status, description and printer capabilities which describe the various print modes a printer supports such as media sizes, margins, etc.

Once built the objects are immutable.

Summary

Nested classes

Builder for creating of a PrinterInfo.

Constants
static Int

Printer status: the printer is busy printing.

static Int

Printer status: the printer is idle and ready to print.

static Int

Printer status: the printer is not available.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

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

PrinterCapabilitiesInfo?

Gets the printer capabilities.

String?

Gets the printer description.

PrinterId

Get the globally unique printer id.

String

Get the printer name.

Int

Gets the printer status.

Int

String

Unit
writeToParcel(parcel: Parcel, flags: Int)

Properties
static Parcelable.Creator<PrinterInfo!>

Constants

STATUS_BUSY

Added in API level 19
static val STATUS_BUSY: Int

Printer status: the printer is busy printing.

Value: 2

STATUS_IDLE

Added in API level 19
static val STATUS_IDLE: Int

Printer status: the printer is idle and ready to print.

Value: 1

STATUS_UNAVAILABLE

Added in API level 19
static val STATUS_UNAVAILABLE: Int

Printer status: the printer is not available.

Value: 3

Public methods

describeContents

Added in API level 19
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

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.

getCapabilities

Added in API level 19
fun getCapabilities(): PrinterCapabilitiesInfo?

Gets the printer capabilities.

Return
PrinterCapabilitiesInfo? The capabilities. This value may be null.

getDescription

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

Gets the printer description.

Return
String? The description. This value may be null.

getId

Added in API level 19
fun getId(): PrinterId

Get the globally unique printer id.

Return
PrinterId The printer id. This value cannot be null.

getName

Added in API level 19
fun getName(): String

Get the printer name.

Return
String The printer name. This value cannot be null.

hashCode

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

toString

Added in API level 19
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 19
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit
Parameters
dest The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 19
static val CREATOR: Parcelable.Creator<PrinterInfo!>